Skip to content

docs: make release changelog commands portable to macOS #853

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.

Sign up for GitHub

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

Merged
samperman merged 2 commits into from
Sep 10, 2026
Merged

docs: make release changelog commands portable to macOS #853

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6d2732
docs: make release changelog commands portable to macOS
samperman Sep 10, 2026
b4b4aa0
Merge remote-tracking branch 'origin/main' into portable-release-comm…
samperman Sep 10, 2026
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
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ before _EACH_ release, even beta releases.
VERSION="$(uv version --bump stable --dry-run --short)" # use "--bump minor" if there are new features
git checkout -b "release-$VERSION" main
uv version "$VERSION"
sed -i "s/^## Unreleased/## [$VERSION] - $(date +%Y-%m-%d)/" docs/CHANGELOG.md
# perl, not sed: GNU sed (Linux) and BSD sed (macOS) take different -i arguments
perl -pi -e "s/^## Unreleased/## [$VERSION] - $(date +%Y-%m-%d)/" docs/CHANGELOG.md
git commit -am "Release $VERSION"
git push -u origin "release-$VERSION"
gh pr create --title "Release $VERSION" --body "Release $VERSION"
Expand Down Expand Up @@ -129,7 +130,7 @@ version
```bash
VERSION="$(uv version --bump patch --bump dev --dry-run --short)" # e.g. 1.29.1 -> 1.29.2.dev1
git checkout -b "rearm-$VERSION" main
sed -i '0,/^## \[/s//## Unreleased\n\n&/' docs/CHANGELOG.md
perl -0777 -pi -e 's/^## \[/## Unreleased\n\n$&/m' docs/CHANGELOG.md
uv version "$VERSION"
git commit -am "Begin $VERSION development"
git push -u origin "rearm-$VERSION"
Expand Down
Loading