Update release process documentation

galaxyproject · Feb 13, 2024 · 13b6ed4 · 13b6ed4
1 parent be90acc
commit 13b6ed4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/doc/source/dev/create_point_release.rst → doc/source/dev/create_release.rst b/doc/source/dev/create_point_release.rst → doc/source/dev/create_release.rst
@@ -1,3 +1,14 @@
+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` at the end of the process.
+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 uploaded by this process, but are instead created by creating a point release, where the first point release should be `vYY.N.0`.
+
 Creating Galaxy Point Releases
 ==============================
 
@@ -10,7 +21,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 +45,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/>`_.
diff --git a/doc/source/dev/index.rst b/doc/source/dev/index.rst
@@ -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