Skip to content

[CHORE](docs) Indicate our brew formula is auto-maintained, no manual post-release steps #123

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
John McCall (lowlydba) merged 3 commits into from
May 4, 2026
Merged

[CHORE](docs) Indicate our brew formula is auto-maintained, no manual post-release steps #123

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f74ba4
Update CONTRIBUTING.md
lowlydba May 1, 2026
d00a3be
Update CONTRIBUTING.md
lowlydba May 1, 2026
8539955
Apply suggestions from code review
lowlydba May 1, 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
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ The package is published to [PyPI](https://pypi.org/project/overturemaps/) via t

1. Update the version in [`pyproject.toml`](pyproject.toml) (field: `project.version`).
2. Commit and merge to `main`.
3. Create a GitHub Release (tag + title + notes). Publishing the release triggers the workflow automatically.
4. The workflow builds the package and publishes to PyPI in the [`pypi` GitHub environment](https://github.com/OvertureMaps/overturemaps-py/deployments).
5. After the release, [open a PR](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request) in [homebrew-core](https://github.com/Homebrew/homebrew-core) to bump the formula version.
3. Create a GitHub Release (tag + title + notes).
4. Creating a new release automatically triggers the following:
- The publish-pypi workflow builds the package and publishes to PyPI in the [`pypi` GitHub environment](https://github.com/OvertureMaps/overturemaps-py/deployments).
- The build-binaries workflow builds cross-OS binaries and attaches them to the release.
- `brew`'s BrewTestBot scans PyPI every 3 hours, and will automatically update our [formula](https://github.com/Homebrew/homebrew-core/blob/main/Formula/o/overturemaps.rb) to the latest version in [Homebrew/homebrew-core](https://github.com/Homebrew/homebrew-core).

### Dry-run / Test PyPI

Expand Down
Loading