Skip to content

Commit

Permalink
Use changelist (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodmillman authored Jul 3, 2023
1 parent a74ee26 commit 1f0052a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
24 changes: 16 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

Example `version`
Example `version number`

- 1.8.dev0 # development version of 1.8 (release candidate 1)
- 1.8rc1 # 1.8 release candidate 1
Expand All @@ -12,21 +12,29 @@ Example `version`

## Process

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

gem install github_changelog_generator
github_changelog_generator -u scientific-python -p yaml2ics --since-tag=<last tag>
export VERSION=<version number>
export PREVIOUS=<previous version number>
export ORG="scientific-python"
export REPO="yaml2ics"

- 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/yaml2ics/releases
https://github.com/scientific-python/yaml2ics/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 @@ -28,7 +28,8 @@ dependencies = [

[project.optional-dependencies]
test = ["pytest >= 7.3", "pytest-cov >= 4.0"]
lint = ["pre-commit >= 3.0"]
lint = ["pre-commit == 3.0"]
dev = ["changelist == 0.1"]

[project.scripts]
yaml2ics = "yaml2ics:cli"
Expand Down

0 comments on commit 1f0052a

Please sign in to comment.