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.

Sign up for GitHub

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

Documentation: Small improvements to Release section of CONTRIBUTING #4208

Merged
merged 1 commit into from
Jan 27, 2025
Merged

Documentation: Small improvements to Release section of CONTRIBUTING #4208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ Use cases

The `release branch` is the ``main`` branch, except for bug fix releases.

First, decide which kind of release is needed:

Release candidates
..................

Expand Down Expand Up @@ -161,6 +163,8 @@ Automated tests
- ``REPOSITORY``: ``https://github.com/<user>/silx`` (default: ``https://github.com/silx-kit/silx``)
- ``TAG``: branch or tag to test (default: ``main`` branch)

These tests take a long time. You can move to the *Prepare the release* section in the meantime.

Manual testing
..............

Expand All @@ -177,7 +181,8 @@ Write the release notes
(see `github automatically generated release notes`_) between a new tag and the previous release.
- Copy the generated changelog to ``CHANGELOG.rst`` and close github's release web page.
**Warning: DO NOT publish the release yet!**
- Sort, curate and fix the list of PRs and match the styling of previous release notes.
- Sort, curate and fix the list of PRs and match the styling of previous release notes. You can run ``tools/format_GH_release_notes.py``
first, that will format the GH release notes in `CHANGELOG_new.rst`.

Steps
.....
Expand Down