Skip to content

Commit dcf95bf

Browse files
committed
Add releasing documentation
1 parent fe4f34a commit dcf95bf

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -197,4 +197,5 @@ git_filter_repo.py --path numpy/array_api/ --path-rename numpy/array_api:array_a
197197
198198
api.rst
199199
changelog.md
200+
releasing.md
200201
```

docs/releasing.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Releasing
2+
3+
To release array-api-strict:
4+
5+
- Create a release branch and make a PR on GitHub.
6+
7+
- Update `changelog.md` with the changes for the release.
8+
9+
- Make sure the CI is passing on the release branch PR. Also double check that
10+
you have properly pulled `main` and merged it into the release branch so
11+
that the branch contains all the necessary changes for the release.
12+
13+
- When you are ready to make the release, create a tag with the release number
14+
15+
```
16+
git tag -a 2.2 -m "array-api-strict 2.2"
17+
```
18+
19+
and push it up to GitHub
20+
21+
```
22+
git push origin --tags
23+
```
24+
25+
This will trigger the `publish-package` build on GitHub Actions. Make sure
26+
that build works correctly and pushes the release up to PyPI. If something
27+
goes wrong, you may need to delete the tag from GitHub and try again.
28+
29+
Note that the `array_api_strict.__version__` version as well as the version
30+
in the package metadata is all automatically computed from the tag, so it is
31+
not necessary to update the version anywhere else.
32+
33+
- Once the release is published, you can merge the PR.
34+
35+
- The conda-forge bot will automatically send a PR to the
36+
[array-api-strict-feedstock](https://github.com/conda-forge/array-api-strict-feedstock)
37+
updating the version, which you should merge.

0 commit comments

Comments
 (0)