Skip to content

Commit

Permalink
Update release process notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jarrodmillman committed Feb 28, 2024
1 parent f443db2 commit b729719
Showing 1 changed file with 28 additions and 8 deletions.
36 changes: 28 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

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.8rc0.dev0 # development version of first 1.8 release candidate
- 1.8rc0 # first 1.8 release candidate
- 1.8rc1.dev0 # development version of second 1.8 release candidate
- 1.8 # 1.8 release
- 1.9.dev0 # development version of 1.9 (release candidate 1)
- 1.9rc0.dev0 # development version of first 1.9 release candidate

## Process

Expand All @@ -18,18 +18,29 @@ Example `version number`
export PREVIOUS=<previous version number>
export ORG="scientific-python"
export REPO="changelist"
export LOG="CHANGELOG.md"

- Update main branch

git switch main
git pull origin main

where `origin` is the name of the `github.com:scientific-python/changelist`
repository

- Autogenerate release notes

changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION}
changelist ${ORG}/${REPO} v${PREVIOUS} main --version ${VERSION} --out ${VERSION}.md

- Put the output of the above command at the top of `CHANGELOG.md`

cat ${VERSION}.md | cat - ${LOG} > temp && mv temp ${LOG}

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

- Commit changes:

git add pyproject.toml CHANGELOG.md
git add pyproject.toml ${LOG}
git commit -m "Designate ${VERSION} release"

- Tag the release in git:
Expand All @@ -43,8 +54,17 @@ Example `version number`

git push --tags origin main

where `origin` is the name of the `github.com:scientific-python/changelist`
repository
- Create release from tag

- go to https://github.com/scientific-python/changelist/releases/new?tag=v${VERSION}
- add v${VERSION} for the `Release title`
- paste contents (or upload) of ${VERSION}.md in the `Describe this release section`
- if pre-release check the box labelled `Set as a pre-release`

- Update https://github.com/scientific-python/changelist/milestones:

- close old milestone
- ensure new milestone exists (perhaps setting due date)

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

Expand Down

0 comments on commit b729719

Please sign in to comment.