Merge pull request #17461 from mvdbeek/document_release_process

Update release process documentation
This commit is contained in:
Marius van den Beek
2024-02-14 14:41:36 +01:00
committed by GitHub
3 changed files with 16 additions and 4 deletions
@@ -1,3 +1,15 @@
Creating Galaxy Releases
========================
The "main" release process is an interactive checklist with instructions (see `Publication of Galaxy Release v 23.2 https://github.com/galaxyproject/galaxy/issues/16742>`_ for an example).
This issue is generated via `make release-issue`.
The final result of the release process are
- a new branch (release_YY.N) from which point releases are created
- a tag pointing at the first commit of the branch (vYY.N)
Python packages are not published by this process, but are instead published by creating point releases where the first point release should be `vYY.N.0`.
Creating Galaxy Point Releases
==============================
@@ -10,7 +22,7 @@ The command is shipped with the `galaxy-release-util <https://pypi.org/project/g
- create HISTORY.rst entries for all packages
- build all packages
- stage and commit all changes
- create a new tag,
- create a new tag,
- (intelligently) merge forward changes to newer release branches and dev
- push changes to the repo identified by `--upstream` (defaults to https://github.com/galaxyporject/galaxy.git/)
@@ -34,4 +46,4 @@ Follow these steps:
When the script is finished you should find a new tag in the GitHub interface, as well as updated release and dev branches.
From the `Releases Interface on GitHub <https://github.com/galaxyproject/galaxy/releases>`_ you can create a new pre-release
associated with the newly created tag. The pre-release event will trigger a github workflow that uploads packages to the `test PyPI instance <https://test.pypi.org/>`_.
If this all looks good you can promote the pre-release to a release and that will trigger the upload to the `main PyPI instance <https://pypi.org/>`_.
If this all looks good you can promote the pre-release to a release and that will trigger the upload to the `main PyPI instance <https://pypi.org/>`_.
+1 -1
View File
@@ -24,4 +24,4 @@ A multi-hour long video playlist covering these slides can be found at
debugging_galaxy
debugging_galaxy_slurm
translating
create_point_release
create_release
+1 -1
View File
@@ -397,7 +397,7 @@ function increment_minor() {
[ "$RELEASE_TYPE" != 'rc' ] || {
log_error "Cannot create rc after release (current version: ${RELEASE_CURR}.0)";
exit 1; }
echo '1.dev0'
echo '0.dev0'
;;
*)
log_error "Don't know how to increment minor version: ${minor}"