Skip to content

Set up bump-my-version and release workflow#89

Merged
aditeyashukla merged 3 commits intoMIT-LAE:mainfrom
ian-ross:automated-releases
Feb 13, 2026
Merged

Set up bump-my-version and release workflow#89
aditeyashukla merged 3 commits intoMIT-LAE:mainfrom
ian-ross:automated-releases

Conversation

@ian-ross
Copy link
Copy Markdown
Member

@ian-ross ian-ross commented Feb 11, 2026

This PR adds bump-my-version as a dependency and adds a GitHub action to create release artifacts when a new version tag is pushed.

The workflow for using this is to do uv run bump-my-version bump minor (or major, or patch), which updates the version number in the pyproject.toml, creates a commit to mark the version update, then creates a tag with the version number. Then you do git push and git push --tags. The GitHub release action then runs. This does a couple of checks, then does a uv build and generates a GitHub release from the results.

Once this is all in place and working, we will be able to update the README to tell people to pip (or better, uv) install AEIC from a GitHub release (which basically means doing uv add https://github.com/MIT-LAE/AEIC/releases/download/v0.1.0/aeic-0.1.0-py3-none-any.whl, where that URL is something you copy&paste from the release page).

This is pretty benign to merge, but I'll need to experiment a little with it once it's in place to make sure that it's working properly. I've tested it on my fork of AEIC, but I'm sure there's room for something to go wrong.

NOTE: I've also reset the version in the pyproject.toml to 0.0.0 in preparation for following the usual major.minor.patch version number pattern. The first time we run bumpy-my-version bump minor to make a release, we'll start on version 0.1.0. Once it's all tested and working, I'll add notes to the developer documentation to describe how to make a release.

@ian-ross
Copy link
Copy Markdown
Member Author

And hey, whaddya know? It doesn't work. I thought I had fixed that problem, but apparently not...

@aditeyashukla aditeyashukla merged commit 8ffbd65 into MIT-LAE:main Feb 13, 2026
4 checks passed
@ian-ross ian-ross deleted the automated-releases branch February 13, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants