mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-03 22:01:39 +00:00
2.0 KiB
2.0 KiB
Steps to release a new GAM version
- In a final commit before release:
- src/gam/__init.py
__version___value should be updated to the new version. - src/GamUpdate.txt should be updated with a high-level changelog.
- wiki/GamUpdates.md should be updated with same high-level changelog.
- wiki/Version-and-Help.md should be updated with current version N.NN.NN
- wiki/How-to-Upgrade-Legacy-GAM-to-GAM7.md should be updated with current version N.NN.NN
- src/gam/__init.py
- The build.yaml Github Action for final commit should complete successfully and creating a new dated Draft release.
- We should NEVER upload release files manually. Only release files automatically created and attested as created by the Github Action should be used.
- Edit the Draft release:
- Create a new tag with the format:
vN.NN.NNwhere N.NN.NN is the GAM release version. - name the release "GAM N.NN.NN" where N.NN.NN is the GAM release version.
- Include the changelog details for the new version in details.
- leave "Set as pre-release" unchecked and "Set as the latest release" checked.
- Publish the release.
- Create a new tag with the format:
TODO: Release Process Improvements
- copying changelog between GamUpdate.txt, GamUpdates.md and release description is manual and tedious. Automate it.
- copying version string from gam/init.py, changelogs and release details and tag in manual and tedious. Automate it.
- See if we can block releases with binaries not uploaded by GitHub Actions to further secure release pipelines.