Skip to content

Commit

Permalink
Merge pull request #166 from smart-on-fhir/mikix/maintainer-update
Browse files Browse the repository at this point in the history
docs: update cut-a-release instructions
  • Loading branch information
mikix authored Jul 23, 2024
2 parents dc211e3 + 2ee5142 commit 796ffa6
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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.
Make a post in the [Zulip channel](https://chat.fhir.org/#narrow/stream/179218-python) for python.

0 comments on commit 796ffa6

Please sign in to comment.