Skip to content

Commit 137cd96

Browse files
committed
docs: update README with CI and publishing details
- Added section on CI processes, including unit tests and E2E test conditions. - Documented the PyPI publishing workflow and local packaging script usage.
1 parent e186344 commit 137cd96

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,10 @@ License
146146
-------
147147
148148
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
149+
150+
CI & Publishing
151+
---------------
152+
153+
- CI runs unit tests and linting on every push. E2E tests run if `GEOCODIO_API_KEY` is set as a secret.
154+
- PyPI publishing workflow supports both TestPyPI and PyPI. See `.github/workflows/publish.yml`.
155+
- Use `test_pypi_release.py` for local packaging and dry-run upload.

0 commit comments

Comments
 (0)