Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use changelist #67

Merged
merged 1 commit into from
Jul 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,39 @@

## Introduction

Example `version`
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.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

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

gem install github_changelog_generator
github_changelog_generator -u scientific-python -p lazy_loader --since-tag=<last tag>
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'
git commit -m "Designate ${VERSION} release"

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

git tag -s [-u <key-id>] v<version> -m 'signed <version> tag'
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
Expand All @@ -40,7 +48,7 @@ Example `version`

- Review the github release page:

https://github.com/scientific-python/lazy_loader/releases
https://github.com/scientific-python/lazy_loader/tags

- Publish on PyPi:

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ description = "Makes it easy to load subpackages and functions on demand."

[project.optional-dependencies]
test = ["pytest >= 7.4", "pytest-cov >= 4.1"]
lint = ["pre-commit >= 3.3"]
lint = ["pre-commit == 3.3"]
dev = ["changelist == 0.1"]

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