Documented the release process

Refs #50
This commit is contained in:
Simon Willison 2023-06-17 16:48:01 +01:00 committed by GitHub
parent 48e1427ec9
commit 88591998e4

View file

@ -33,3 +33,13 @@ This will start a live preview server, using [sphinx-autobuild](https://pypi.org
The CLI `--help` examples in the documentation are managed using [Cog](https://github.com/nedbat/cog). Update those files like this:
cog -r docs/*.md
## Release process
To release a new version:
1. Update `docs/changelog.md` with the new changes.
2. Update the version number in `setup.py`
3. [Create a GitHub release](https://github.com/simonw/llm/releases/new) for the new version.
4. Wait for the package to push to PyPI and then...
5. Run the [regenerate.yaml](https://github.com/simonw/homebrew-llm/blob/main/.github/workflows/regenerate.yaml) workflow to update the Homebrew tap to the latest version.