Skip to content
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Document release process in README
  • Loading branch information
ilyazub committed Mar 18, 2026
commit fd4b60b1b3a95ee49caf9003e069c1d895cc4d75
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,3 +369,15 @@ MIT License.
## Contributing

Bug reports and pull requests are welcome on GitHub. Once dependencies are installed, you can run the tests with `pytest`.

## Publishing a new release

1. Update the version in `serpapi/__version__.py`.
2. Push a tag — the release pipeline runs automatically:
```sh
git tag v1.2.3
git push origin v1.2.3
```
This triggers the [release workflow](.github/workflows/release.yml), which tests, builds, and publishes to PyPI, then smoke-tests the published package.

> **Required secrets:** `PYPI_API_TOKEN` (PyPI upload token) and `API_KEY` (used in smoke-test live search).