Skip to content

Commit 017345f

Browse files
Update release process doc (#105)
1 parent 4ced6c7 commit 017345f

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

RELEASE.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,21 @@ Example `version number`
1818
export PREVIOUS=<previous version number>
1919
export ORG="scientific-python"
2020
export REPO="lazy_loader"
21+
export LOG="CHANGELOG.md"
2122

2223
- Autogenerate release notes
2324

24-
changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}
25+
changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION} --config pyproject.toml --out ${VERSION}.md
2526

2627
- Put the output of the above command at the top of `CHANGELOG.md`
2728

28-
- Update `version` in `pyproject.toml`.
29+
cat ${VERSION}.md | cat - ${LOG} > temp && mv temp ${LOG}
30+
31+
- Update `version` in `lazy_loader/__init__.py`.
2932

3033
- Commit changes:
3134

32-
git add pyproject.toml CHANGELOG.md
35+
git add lazy_loader/__init__.py ${LOG}
3336
git commit -m "Designate ${VERSION} release"
3437

3538
- Tag the release in git:
@@ -46,10 +49,22 @@ Example `version number`
4649
where `origin` is the name of the `github.com:scientific-python/lazy_loader`
4750
repository
4851

49-
- Update `version` in `pyproject.toml`.
52+
- Create release from tag
53+
54+
- go to https://github.com/scientific-python/lazy_loader/releases/new?tag=v${VERSION}
55+
- add v${VERSION} for the `Release title`
56+
- paste contents (or upload) of ${VERSION}.md in the `Describe this release section`
57+
- if pre-release check the box labelled `Set as a pre-release`
58+
59+
- Update https://github.com/scientific-python/lazy_loader/milestones:
60+
61+
- close old milestone
62+
- ensure new milestone exists (perhaps setting due date)
63+
64+
- Update `version` in `lazy_loader/__init__.py`.
5065

5166
- Commit changes:
5267

53-
git add pyproject.toml
68+
git add lazy_loader/__init__.py
5469
git commit -m 'Bump version'
5570
git push origin main

0 commit comments

Comments
 (0)