Skip to content

docs: update README release process for release-please #450

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
pdecat merged 1 commit into from
Jul 18, 2026
Merged

docs: update README release process for release-please #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,11 +392,8 @@ poetry run pytest

* release:

```
export CHANGELOG_GITHUB_TOKEN=$(gopass show -o pins/Github/github-changelog-generator)
./scripts/release.sh patch # or minor, major, prepatch, preminor, premajor, prerelease, or a valid semver string
```
Releases are automated with [release-please](https://github.com/googleapis/release-please): every push to `master` maintains a release pull request that bumps the version and updates `CHANGELOG.md` from the [Conventional Commits](https://www.conventionalcommits.org/) since the last release. Merging that pull request tags the release, publishes it on GitHub, and uploads the distributions to PyPI via OIDC trusted publishing.

## Changelog

See the [CHANGELOG.md](CHANGELOG.md) file, which is generated using [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator).
See the [CHANGELOG.md](CHANGELOG.md) file, which is generated from [Conventional Commits](https://www.conventionalcommits.org/) by [release-please](https://github.com/googleapis/release-please).
Loading