Versioning is using MinVer. No changes in the code are needed to correctly version this package.
-
Update the version in the following files:
-
Update the CHANGELOG.md with the new release.
-
Create a pull request on GitHub with the changes described in the changelog.
*scripts*
andvalidate-documentation
jobs will fail because the release is not published yet.
-
Once the pull request has been merged, create a signed tag for the merged commit. You can do this using the following Bash snippet:
TAG='v{new-version-here}' COMMIT='{commit-sha-here}' git tag -s -m $TAG $TAG $COMMIT git push upstream $TAG
After you've pushed the git tag, a
ci
GitHub workflow starts. -
Publish a release in GitHub:
- Use the CHANGELOG.md content in the description.
- Add the artifacts from the
ci
GitHub workflow related to the created tag.