SOP to create a new release in smtml.
- Trigger the Release PR workflow.
- Approve the PR and merge changes to main.
- Locally, pull the changes and tag the latest commit with
v[VERSION], whereVERSIONis the version created by the workflow. - Push the tag.
- Re-run the latest opam-repository CI to automatically publish the package.
- Track the created PR in the opam-repository to check for CI errors or comments from maintainers.
Note: There is a cron job in GitHub that is set to run the Release PR workflow every monday at 9AM.
# 1. Run the create-release.sh script:
# a. If no version is specified, the create-release.sh script simply bumps the current version.
./create-release.sh
# b. If specified, it will use the provided tag instead. Example:
# ./create-release.sh 0.18.0
# 2. Approve the created PR and merge it to main.
# 3. Update the main branch:
git switch main
git fetch --all
git rebase
# 4. Create the tag:
git tag -a vVERSION # Where VERSION is the desired version
git push -u origin vVERSION
# 5. Publish new version to the opam-repository:
./publish.sh