1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# Release process for `lazy_loader`
## Introduction
Example `version number`
- 1.8.dev0 # development version of 1.8 (release candidate 1)
- 1.8rc1 # 1.8 release candidate 1
- 1.8rc2.dev0 # development version of 1.8 release candidate 2
- 1.8 # 1.8 release
- 1.9.dev0 # development version of 1.9 (release candidate 1)
## Process
- Set release variables:
export VERSION=<version number>
export PREVIOUS=<previous version number>
export ORG="scientific-python"
export REPO="lazy_loader"
- Autogenerate release notes
changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}
- Put the output of the above command at the top of `CHANGELOG.md`
- Update `version` in `pyproject.toml`.
- Commit changes:
git add pyproject.toml CHANGELOG.md
git commit -m "Designate ${VERSION} release"
- Tag the release in git:
git tag -s v${VERSION} -m "signed ${VERSION} tag"
If you do not have a gpg key, use -u instead; it is important for
Debian packaging that the tags are annotated
- Push the new meta-data to github:
git push --tags origin main
where `origin` is the name of the `github.com:scientific-python/lazy_loader`
repository
- Update `version` in `pyproject.toml`.
- Commit changes:
git add pyproject.toml
git commit -m 'Bump version'
git push origin main
|
