From 2ee51429cc6d024882a082ea11a084c86a1d5903 Mon Sep 17 00:00:00 2001 From: Michael Terry Date: Tue, 23 Jul 2024 09:12:49 -0400 Subject: [PATCH] docs: update cut-a-release instructions --- MAINTAINERS.md | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index d9cbf905..f5766058 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -5,12 +5,19 @@ pip install -U build python3 -m build -### Incrementing the lib version +## Incrementing the lib version - Edit `fhirclient/client.py` and change the `__version__` field. - Edit `docs/Doxyfile` and change the `PROJECT_NUMBER` field. -## Docs Generation +## Cutting a new release + +1. Make sure that the version is correct in the source (see above for update instructions). +2. Update the docs +3. Release on GitHub +4. Announce on Zulip + +### Docs Generation Docs are generated with [Doxygen](https://www.doxygen.nl/) and [doxypypy](https://github.com/Feneric/doxypypy). @@ -24,23 +31,12 @@ I usually perform a second checkout of the _gh-pages_ branch and copy the HTML f doxygen docs/Doxyfile rsync -a docs/html/ ../client-py-web/ -## PyPi Publishing (notes for SMART team) - -Using flit (*Note*: Alternatively, you can use [twine](https://twine.readthedocs.io/)): - -### Make sure that you have the PyPi account credentials in your account - - copy server.smarthealthit.org:/home/fhir/.pypirc to ~/.pypirc - -### Test the build - - python3 -m build +### Release on GitHub -### Upload the packages to PyPi +Just create a new release in GitHub and create a corresponding tag. - pip install -U flit - flit publish +This will also cause the `pypi.yaml` GitHub Action to fire, uploading to PyPI. ### Announce the release -Make a post in the [Zulip channel](https://chat.fhir.org/#narrow/stream/179218-python) for python. \ No newline at end of file +Make a post in the [Zulip channel](https://chat.fhir.org/#narrow/stream/179218-python) for python.