With this issue, we keep track of the workflow for version 0.1.0 release.
Preparation of the release
[x] tag all PRs that are part of this release by adding them to a milestone named Release-0.1.0.
[x] Create a release branch release-0.1.0
[x] Adjust Project.toml on release-0.1.0 by ticking up the version
[x] Add/Update the file CHANGELOG.md on release-0.1.0 by appending a summary section. This can be done by using the tagged PRs associated with this release.
Releasing procedure
[x] open PR for merging release-0.1.0 into main with at least one reviewer (who only needs to check the points above, the code additions were reviewed in the respective PRs). The merge must not delete the source branch. :warning: DO NOT SQUASH THIS MERGE :warning:
[x] after the release branch is merged into main, open another PR for merging release-0.1.0 into dev. This can be merged without much review because the relevant changes were already reviewed in the PR release-0.1.0 -> main. :warning: DO NOT SQUASH THIS MERGE EITHER :warning:
[x] Registration: go to the issues and search for Release. There, write a comment with at_JuliaRegistrator register() with a real @ to trigger the registration bot opening a PR on Julia's general registry.
[x] after the registration bot reports back the correct registration, tag the HEAD of main (which should still be the merge commit from the release branch merge) with v0.1.0
[x] Build a GitHub release from the latest tagged commit on main and add the respective section from CHANGELOG.md to the release notes.
Final remarks
This issue can also be used as a blueprint for future releases. At some point, we should add this to the contributor's documentation.
some of the tasks above can be automated, e.g. the tagging and building of the GitHub release can be done using the Julia-TagBot, which is actually a GitHub action.
With this issue, we keep track of the workflow for version
0.1.0
release.Preparation of the release
Release-0.1.0
.release-0.1.0
Project.toml
onrelease-0.1.0
by ticking up the versionCHANGELOG.md
onrelease-0.1.0
by appending a summary section. This can be done by using the tagged PRs associated with this release.Releasing procedure
release-0.1.0
intomain
with at least one reviewer (who only needs to check the points above, the code additions were reviewed in the respective PRs). The merge must not delete the source branch. :warning: DO NOT SQUASH THIS MERGE :warning:main
, open another PR for mergingrelease-0.1.0
intodev
. This can be merged without much review because the relevant changes were already reviewed in the PRrelease-0.1.0 -> main
. :warning: DO NOT SQUASH THIS MERGE EITHER :warning:Release
. There, write a comment withat_JuliaRegistrator register()
with a real@
to trigger the registration bot opening a PR on Julia's general registry.main
(which should still be the merge commit from the release branch merge) withv0.1.0
main
and add the respective section fromCHANGELOG.md
to the release notes.Final remarks