@@ -54,37 +54,50 @@ git push origin main
5454git push origin v1.1.0
5555```
5656
57- ### 4. Create GitHub Release
57+ ### 4. Automated PyPI Publication
58+
59+ After pushing the tag, the GitHub Actions workflow will automatically:
60+ - Run all tests (pre-commit, pytest, docs)
61+ - Build the distribution packages
62+ - Publish to PyPI using the ` PYPI_KEY ` secret
63+
64+ You can monitor the progress at:
65+ https://github.com/executablebooks/sphinx-exercise/actions
66+
67+ ### 5. Create GitHub Release
68+
69+ Once the workflow completes successfully:
5870
59711 . Go to https://github.com/executablebooks/sphinx-exercise/releases/new
60722 . Select tag: ` v1.1.0 `
61733 . Release title: ` v1.1.0 - Internationalization Support `
62744 . Description: Copy content from ` docs/source/releases/v1.1.0.md `
63755 . Click "Publish release"
6476
65- ### 5. Publish to PyPI
66-
67- ``` bash
68- # Clean previous builds
69- rm -rf dist/ build/ * .egg-info
70-
71- # Build distribution
72- python -m build
73-
74- # Upload to PyPI (requires PyPI credentials)
75- python -m twine upload dist/*
76- ```
77-
7877### 6. Update Documentation
7978
8079The documentation should automatically build from the new tag on ReadTheDocs. Verify at:
8180https://ebp-sphinx-exercise.readthedocs.io/en/latest/
8281
8382### 7. Post-Release
8483
85- 1 . Update ` docs/source/releases/index.md ` to include v1.1.0
86- 2 . Create new "Unreleased" section in CHANGELOG.md for future changes
87- 3 . Announce release on relevant channels
84+ 1 . Verify the package is available on PyPI: https://pypi.org/project/sphinx-exercise/
85+ 2 . Update ` docs/source/releases/index.md ` to include v1.1.0
86+ 3 . Create new "Unreleased" section in CHANGELOG.md for future changes
87+ 4 . Announce release on relevant channels
88+
89+ ## Automated Release Process
90+
91+ This project uses GitHub Actions to automatically publish to PyPI when a version tag is pushed:
92+
93+ 1 . ** Triggering** : The workflow is triggered when a tag matching ` v* ` is pushed
94+ 2 . ** Testing** : All tests (pre-commit, pytest, documentation) must pass
95+ 3 . ** Building** : The workflow builds the distribution packages using ` python -m build `
96+ 4 . ** Publishing** : Packages are automatically published to PyPI using the ` PYPI_KEY ` secret
97+
98+ ** Important** : Ensure the ` PYPI_KEY ` secret is configured in the repository settings with a valid PyPI API token.
99+
100+ The workflow definition can be found in ` .github/workflows/ci.yml ` under the ` publish ` job.
88101
89102## Version Numbering
90103
0 commit comments