Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release process documentation #17461

Merged
merged 4 commits into from
Feb 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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.
mvdbeek marked this conversation as resolved.
Show resolved Hide resolved
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)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we still want this ? It doesn't hurt anything, but maybe we should let the first point release create the first tag ?

mvdbeek marked this conversation as resolved.
Show resolved Hide resolved

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`.
mvdbeek marked this conversation as resolved.
Show resolved Hide resolved

Creating Galaxy Point Releases
==============================

Expand All @@ -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/)

Expand All @@ -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/>`_.
2 changes: 1 addition & 1 deletion doc/source/dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Expand Down
Loading