22
33## Introduction
44
5- Example ` version `
5+ Example ` version number `
66
77- 1.8.dev0 # development version of 1.8 (release candidate 1)
88- 1.8rc1 # 1.8 release candidate 1
@@ -12,22 +12,29 @@ Example `version`
1212
1313## Process
1414
15- - Update and review ` CHANGELOG.md ` :
15+ - Set release variables :
1616
17- changelist scientific-python/changelist <v0.0> main --version <0.1> >> CHANGELOG.md
17+ export VERSION=<version number>
18+ export PREVIOUS=<previous version number>
19+ export ORG="scientific-python"
20+ export REPO="changelist"
1821
19- where <v0.0> is the last release and <0.1> is the new one.
22+ - Autogenerate release notes
23+
24+ changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}
25+
26+ - Put the output of the above command at the top of ` CHANGELOG.md `
2027
2128- Update ` version ` in ` pyproject.toml ` .
2229
2330- Commit changes:
2431
2532 git add pyproject.toml CHANGELOG.md
26- git commit -m ' Designate <version> release'
33+ git commit -m " Designate ${VERSION} release"
2734
28- - Add the version number (e.g., ` 1.2.0 ` ) as a tag in git:
35+ - Tag the release in git:
2936
30- git tag -s [-u <key-id>] v<version> -m ' signed <version> tag'
37+ git tag -s v${VERSION} -m " signed ${VERSION} tag"
3138
3239 If you do not have a gpg key, use -u instead; it is important for
3340 Debian packaging that the tags are annotated
@@ -48,7 +55,7 @@ Example `version`
4855 git clean -fxd
4956 pip install -U build twine wheel
5057 python -m build --sdist --wheel
51- twine upload -s dist/*
58+ twine upload dist/*
5259
5360- Update ` version ` in ` pyproject.toml ` .
5461
0 commit comments