Skip to content

Commit 796ffa6

Browse files
authored
Merge pull request #166 from smart-on-fhir/mikix/maintainer-update
docs: update cut-a-release instructions
2 parents dc211e3 + 2ee5142 commit 796ffa6

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

MAINTAINERS.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,19 @@
55
pip install -U build
66
python3 -m build
77

8-
### Incrementing the lib version
8+
## Incrementing the lib version
99

1010
- Edit `fhirclient/client.py` and change the `__version__` field.
1111
- Edit `docs/Doxyfile` and change the `PROJECT_NUMBER` field.
1212

13-
## Docs Generation
13+
## Cutting a new release
14+
15+
1. Make sure that the version is correct in the source (see above for update instructions).
16+
2. Update the docs
17+
3. Release on GitHub
18+
4. Announce on Zulip
19+
20+
### Docs Generation
1421

1522
Docs are generated with [Doxygen](https://www.doxygen.nl/)
1623
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
2431
doxygen docs/Doxyfile
2532
rsync -a docs/html/ ../client-py-web/
2633

27-
## PyPi Publishing (notes for SMART team)
28-
29-
Using flit (*Note*: Alternatively, you can use [twine](https://twine.readthedocs.io/)):
30-
31-
### Make sure that you have the PyPi account credentials in your account
32-
33-
copy server.smarthealthit.org:/home/fhir/.pypirc to ~/.pypirc
34-
35-
### Test the build
36-
37-
python3 -m build
34+
### Release on GitHub
3835

39-
### Upload the packages to PyPi
36+
Just create a new release in GitHub and create a corresponding tag.
4037

41-
pip install -U flit
42-
flit publish
38+
This will also cause the `pypi.yaml` GitHub Action to fire, uploading to PyPI.
4339

4440
### Announce the release
4541

46-
Make a post in the [Zulip channel](https://chat.fhir.org/#narrow/stream/179218-python) for python.
42+
Make a post in the [Zulip channel](https://chat.fhir.org/#narrow/stream/179218-python) for python.

0 commit comments

Comments
 (0)