Skip to content

Commit 29a0734

Browse files
authored
DOC Update maintainers doc (#196)
1 parent f8e068c commit 29a0734

File tree

1 file changed

+29
-21
lines changed

1 file changed

+29
-21
lines changed

README.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -332,40 +332,48 @@ https://github.com/xianyi/OpenBLAS/issues/2985).
332332

333333
To make a release:
334334

335-
- Bump the version number (`__version__`) in `threadpoolctl.py` and update the
336-
release date in `CHANGES.md`.
335+
- Create a PR to bump the version number (`__version__`) in `threadpoolctl.py` and
336+
update the release date in `CHANGES.md`.
337337

338-
- Build the distribution archives:
338+
- Merge the PR and check that the `Publish threadpoolctl distribution to TestPyPI` job
339+
of the `publish-to-pypi.yml` workflow successfully uploaded the wheel and source
340+
distribution to Test PyPI.
339341

340-
```bash
341-
pip install flit
342-
flit build
343-
```
342+
- If everything is fine create a tag for the release and push it to github:
344343

345-
and check the contents of `dist/`.
344+
```bash
345+
git tag -a X.Y.Z
346+
git push [email protected]:joblib/threadpoolctl.git X.Y.Z
347+
```
346348

347-
- If everything is fine, make a commit for the release, tag it and push the
348-
tag to github:
349+
- Check that the `Publish threadpoolctl distribution to PyPI` job of the
350+
`publish-to-pypi.yml` workflow successfully uploaded the wheel and source distribution
351+
to PyPI this time.
349352

350-
```bash
351-
git tag -a X.Y.Z
352-
git push [email protected]:joblib/threadpoolctl.git X.Y.Z
353-
```
353+
- Create a PR for the release on the [conda-forge feedstock](https://github.com/conda-forge/threadpoolctl-feedstock) (or wait for the bot to make it).
354+
355+
- Publish the release on github.
356+
357+
If for some reason the steps above can't be achieved and a munual upload of the wheel
358+
and source distribution is needed:
359+
360+
- Build the distribution archives:
361+
362+
```bash
363+
pip install flit
364+
flit build
365+
```
354366

355367
- Upload the wheels and source distribution to PyPI using flit. Since PyPI doesn't
356368
allow password authentication anymore, the username needs to be changed to the
357369
generic name `__token__`:
358370

359-
```bash
360-
FLIT_USERNAME=__token__ flit publish
361-
```
371+
```bash
372+
FLIT_USERNAME=__token__ flit publish
373+
```
362374

363375
and a PyPI token has to be passed in place of the password.
364376

365-
- Create a PR for the release on the [conda-forge feedstock](https://github.com/conda-forge/threadpoolctl-feedstock) (or wait for the bot to make it).
366-
367-
- Publish the release on github.
368-
369377
### Credits
370378

371379
The initial dynamic library introspection code was written by @anton-malakhov

0 commit comments

Comments
 (0)