fms‐acceleration PiPY Wheel Release Instructions

Since fms-acceleration is a mono-repo, the build processes are tailored for it.

1. Check each package that has changes. Can use the “Generate release notes” feature in Github releases, or a tool like Sourcetree. For each package, decide if it is a minor or patch change based on the changes. If framework hasn't changed, the new version should be vX.Y.Z.n+1. For example, if the previous version was v0.6.1, but the framework hasn't been updated, the new version will be v0.6.1.1. If v0.6.1.1 was the last version, the next will be v0.6.1.2. If the framework has changed, do a patch release as normal.

2. Create a single “bump versions” commit in a new branch on the main fork called <new framework version>_bump_version (see example), and update the versions of the packages that have changed. remove the .dev tag and bump versions.

3. Draft Release: indicate what has changed for each package, and indicate if its a minor or patch release. Create a new tag indicating the new version of the framework, using your newly created branch in step 2 as the target. See example below:

4. Publish release: Upon publishing the Github release, this will trigger the pypi push of the plugins. Any plugin where the pyproject.toml has changed due to the new version bump will be published. https://pypi.org/project/fms-acceleration/#history

5. In your working release branch, after the new versions have been updated on pypi, add the .dev tags back in then use git commit --amend to amend your previous commit with the .dev tags. Then checkout the main branch and do git cherry-pick <hash of amended commit> to pull the commit to main, then push. This should create a single “bump versions” commit in main by amending the tag commit, adding back .dev tag