2
2
3
3
## Introduction
4
4
5
- Example ` version `
5
+ Example ` version number `
6
6
7
7
- 1.8.dev0 # development version of 1.8 (release candidate 1)
8
8
- 1.8rc1 # 1.8 release candidate 1
9
- - 1.8rc2.dev0 # development version of 1.8 ( release candidate 2)
9
+ - 1.8rc2.dev0 # development version of 1.8 release candidate 2
10
10
- 1.8 # 1.8 release
11
11
- 1.9.dev0 # development version of 1.9 (release candidate 1)
12
12
13
13
## Process
14
14
15
- - Update and review ` CHANGELOG.md ` :
15
+ - Set release variables :
16
16
17
- gem install github_changelog_generator
18
- github_changelog_generator -u scientific-python -p lazy_loader --since-tag=<last tag>
17
+ export VERSION=<version number>
18
+ export PREVIOUS=<previous version number>
19
+ export ORG="scientific-python"
20
+ export REPO="lazy_loader"
21
+
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 `
19
27
20
28
- Update ` version ` in ` pyproject.toml ` .
21
29
22
30
- Commit changes:
23
31
24
32
git add pyproject.toml CHANGELOG.md
25
- git commit -m ' Designate <version> release'
33
+ git commit -m " Designate ${VERSION} release"
26
34
27
- - Add the version number (e.g., ` 1.2.0 ` ) as a tag in git:
35
+ - Tag the release in git:
28
36
29
- git tag -s [-u <key-id>] v<version> -m ' signed <version> tag'
37
+ git tag -s v${VERSION} -m " signed ${VERSION} tag"
30
38
31
39
If you do not have a gpg key, use -u instead; it is important for
32
40
Debian packaging that the tags are annotated
@@ -40,7 +48,7 @@ Example `version`
40
48
41
49
- Review the github release page:
42
50
43
- https://github.com/scientific-python/lazy_loader/releases
51
+ https://github.com/scientific-python/lazy_loader/tags
44
52
45
53
- Publish on PyPi:
46
54
0 commit comments