Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: payno <[email protected]>
  • Loading branch information
t20100 and payno authored Jun 13, 2024
1 parent 4a55e0f commit 96657cb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Automated tests

- Run the `release workflow`_ manually (see `manually running a workflow`_) to check that the release artifacts are built correctly.
The wheels generated by the workflow can be downloaded from the release workflow run web page.
Note: Running the workflow manually do NOT publish artifacts to pypi.
*Note: Running the workflow manually do NOT publish artifacts to pypi.*

- Run the `previous release workflow`_ with the following variables:
- ``REPOSITORY``: ``https://github.com/<user>/silx`` (default: ``https://github.com/silx-kit/silx``)
Expand All @@ -127,7 +127,7 @@ Write the release notes

- Generate the list of pull requests included in the release with github's automatically generated 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!
**Warning: DO NOT publish the release yet!**
- Sort, curate and fix the list of PRs and match the styling of previous release notes.

Steps
Expand All @@ -144,7 +144,7 @@ Create the release
..................

* Draft a new release from `github new release page`_ using similar conventions as previous releases:
- Create a new tag which MUST be named ``v<release_version>`` and match the version in ``src/silx/_version.py``.
- Create a new tag which **MUST** be named ``v<release_version>`` and match the version in ``src/silx/_version.py``.
- Combine the release notes manually edited from ``CHANGELOG.rst`` with `github automatically generated release notes`_.
* Press the "Publish release" button to trigger the release workflow which builds the documentation, the source tarball and the wheels.

Expand Down

0 comments on commit 96657cb

Please sign in to comment.