Skip to content

Commit 4bf578d

Browse files
authored
update instructions with template checklist (#242)
1 parent 7e2ca18 commit 4bf578d

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

docs/development/release_instructions.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,26 @@ Instructions
3535
Add and commit ``long_description.rst``.
3636
5. Push the branch onto your forked repository and open a pull request.
3737
6. Name the Pull Request ``[REL] vX.Y.ZrcN``
38-
7. After reviewing ``CHANGELOG.rst`` and ``long_description.rst``, merge the pull request.
39-
8. Go to the Releases section on the repository and create a new release.
40-
9. Copy the brief summary from ``CHANGELOG.rst`` and add it below the ``CHANGES`` section
41-
in the text provided by Release Drafter.
42-
10. Tag the release as ``vX.Y.ZrcN`` where X, Y, and Z are the major, minor, and patch numbers
38+
7. Create a checklist to ensure:
39+
40+
- ``CHANGELOG.rst`` is finalized
41+
- ``long_description.rst`` is finalized
42+
- new contributors are added to ``.zenodo.json``
43+
- ask repeat contributors if they want to be a creator.
44+
- other issues that pop up during the release (for example, deployment is not working)
45+
46+
8. After all creators review ``CHANGELOG.rst`` and optionally other changes, merge the pull request.
47+
9. Go to the Releases section on the repository and create a new release.
48+
10. Copy the brief summary from ``CHANGELOG.rst`` and add it below the ``CHANGES`` section
49+
in the text provided by Release Drafter.
50+
11. Tag the release as ``vX.Y.ZrcN`` where X, Y, and Z are the major, minor, and patch numbers
4351
respectively, and N is the release candidate number starting with 1.
44-
11. Mark the release as a pre-release.
45-
12. Create the release and check if nibetaseries is being built and deployed on ``dockerhub``
52+
12. Mark the release as a pre-release.
53+
13. Create the release and check if nibetaseries is being built and deployed on ``dockerhub``
4654
and ``pypi`` correctly.
47-
13. If not successful, create another branch called ``rel_vX.Y.ZrcN`` with N being incremented.
48-
14. Make the necessary changes to fix deployment and go back to step 5.
49-
15. If successful, create a new tag ``vX.Y.Z`` copying all release drafter information
55+
14. If not successful, create another branch called ``rel_vX.Y.ZrcN`` with N being incremented.
56+
15. Make the necessary changes to fix deployment and go back to step 5.
57+
16. If successful, create a new tag ``vX.Y.Z`` copying all release drafter information
5058
from the last successful release candidate.
5159

5260
Yay! If you've followed these instructions, you'll be a release pro in no time.

0 commit comments

Comments
 (0)