Skip to content

Commit 27719a4

Browse files
committed
Update release procedure in doc/dev
1 parent d453815 commit 27719a4

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

doc/dev.rst

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To retrieve them, use one of the following methods:
4747

4848
$ git clone git@github.com:khaeru/sdmx-test-data.git
4949

50-
b. Download https://github.com/khaeru/sdmx-test-data/archive/main.zip
50+
b. Download https://github.com/khaeru/sdmx-test-data/archive/.zip
5151

5252
2. Indicate where pytest can find the files, by one of two methods:
5353

@@ -91,35 +91,43 @@ Before releasing, check:
9191

9292
Address any failures before releasing.
9393

94-
1. Edit :file:`doc/whatsnew.rst`.
94+
1. Create a new branch::
95+
96+
$ git checkout -v release/X.Y.Z
97+
98+
2. Edit :file:`doc/whatsnew.rst`.
9599
Comment the heading "Next release", then insert another heading below it, at the same level, with the version number and date.
96-
Make a commit with a message like "Mark vX.Y.Z in doc/whatsnew".
97100

98-
2. Tag the version as a release candidate, i.e. with a ``rcN`` suffix, and push::
101+
3. Make a commit with a message like "Mark vX.Y.Z in doc/whatsnew".
99102

100-
$ git tag v1.2.3rc1
101-
$ git push --tags origin main
103+
4. Tag the version as a release candidate, i.e. with a ``rcN`` suffix, and push::
102104

103-
3. Check:
105+
$ git tag vX.Y.ZrcN
106+
$ git push --tags --set-upstream origin release/X.Y.Z
107+
108+
5. Open a pull request with the title “Release vX.Y.Z” using this branch.
109+
Check:
104110

105111
- at https://github.com/khaeru/sdmx/actions?query=workflow:publish that the workflow completes: the package builds successfully and is published to TestPyPI.
106112
- at https://test.pypi.org/project/sdmx1/ that:
107113

108114
- The package can be downloaded, installed and run.
109115
- The README is rendered correctly.
110116

111-
Address any warnings or errors that appear.
112-
If needed, make a new commit and go back to step (2), incrementing the rc number.
117+
If needed, address any warnings or errors that appear and then continue from step (3), i.e. make (a) new commit(s) and tag, incrementing the release candidate number, e.g. from ``rc1`` to ``rc2``.
118+
119+
6. Merge the PR using the “rebase and merge” method.
113120

114-
4. **Optional.** This step (but *not* step (2)) can also be performed directly on GitHub; see (5), next.
115-
Tag the release itself and push::
121+
7. (optional) Tag the release itself and push::
116122

117-
$ git tag v1.2.3
123+
$ git tag vX.Y.Z
118124
$ git push --tags origin main
119125

120-
5. Visit https://github.com/khaeru/sdmx/releases and mark the new release: either using the pushed tag from (4), or by creating the tag and release simultaneously.
126+
This step (but *not* step (3)) can also be performed directly on GitHub; see (7), next.
127+
128+
8. Visit https://github.com/khaeru/sdmx/releases and mark the new release: either using the pushed tag from (7), or by creating the tag and release simultaneously.
121129

122-
6. Check at https://github.com/khaeru/sdmx/actions?query=workflow:publish and https://pypi.org/project/sdmx1/ that the distributions are published.
130+
9. Check at https://github.com/khaeru/sdmx/actions?query=workflow:publish and https://pypi.org/project/sdmx1/ that the distributions are published.
123131

124132

125133
Internal code reference

0 commit comments

Comments
 (0)