Skip to content

Commit fd4b60b

Browse files
committed
Document release process in README
1 parent 97990a5 commit fd4b60b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,3 +369,15 @@ MIT License.
369369
## Contributing
370370

371371
Bug reports and pull requests are welcome on GitHub. Once dependencies are installed, you can run the tests with `pytest`.
372+
373+
## Publishing a new release
374+
375+
1. Update the version in `serpapi/__version__.py`.
376+
2. Push a tag — the release pipeline runs automatically:
377+
```sh
378+
git tag v1.2.3
379+
git push origin v1.2.3
380+
```
381+
This triggers the [release workflow](.github/workflows/release.yml), which tests, builds, and publishes to PyPI, then smoke-tests the published package.
382+
383+
> **Required secrets:** `PYPI_API_TOKEN` (PyPI upload token) and `API_KEY` (used in smoke-test live search).

0 commit comments

Comments
 (0)