Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2bb217a

Browse filesBrowse files
Use changelist (#67)
1 parent d2c72b0 commit 2bb217a
Copy full SHA for 2bb217a

File tree

Expand file treeCollapse file tree

2 files changed

+19
-10
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+19
-10
lines changed

‎RELEASE.md

Copy file name to clipboardExpand all lines: RELEASE.md
+17-9Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,39 @@
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
9-
- 1.8rc2.dev0 # development version of 1.8 (release candidate 2)
9+
- 1.8rc2.dev0 # development version of 1.8 release candidate 2
1010
- 1.8 # 1.8 release
1111
- 1.9.dev0 # development version of 1.9 (release candidate 1)
1212

1313
## Process
1414

15-
- Update and review `CHANGELOG.md`:
15+
- Set release variables:
1616

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`
1927

2028
- Update `version` in `pyproject.toml`.
2129

2230
- Commit changes:
2331

2432
git add pyproject.toml CHANGELOG.md
25-
git commit -m 'Designate <version> release'
33+
git commit -m "Designate ${VERSION} release"
2634

27-
- Add the version number (e.g., `1.2.0`) as a tag in git:
35+
- Tag the release in git:
2836

29-
git tag -s [-u <key-id>] v<version> -m 'signed <version> tag'
37+
git tag -s v${VERSION} -m "signed ${VERSION} tag"
3038

3139
If you do not have a gpg key, use -u instead; it is important for
3240
Debian packaging that the tags are annotated
@@ -40,7 +48,7 @@ Example `version`
4048

4149
- Review the github release page:
4250

43-
https://github.com/scientific-python/lazy_loader/releases
51+
https://github.com/scientific-python/lazy_loader/tags
4452

4553
- Publish on PyPi:
4654

‎pyproject.toml

Copy file name to clipboardExpand all lines: pyproject.toml
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ description = "Makes it easy to load subpackages and functions on demand."
2424

2525
[project.optional-dependencies]
2626
test = ["pytest >= 7.4", "pytest-cov >= 4.1"]
27-
lint = ["pre-commit >= 3.3"]
27+
lint = ["pre-commit == 3.3"]
28+
dev = ["changelist == 0.1"]
2829

2930
[project.urls]
3031
Home = "https://scientific-python.org/specs/spec-0001/"

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.