Skip to content

Commit 5def40b

Browse files
committed
update release guide
1 parent b49fa92 commit 5def40b

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

doc/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@ The iminuit logo uses glyphs generated from the free Gentium Plus font.
66
How to make a release
77
=====================
88

9+
- On develop
10+
- Update `src/iminuit/version.py` to released version
11+
- Update `doc/changelog.rst` to released version and add today's date
12+
- Note: A prerelease can be published simply by adding `.rcN` to `iminuit_version`,
13+
where N is a number >= 0
914
- Merge develop into master
1015
- Option: do a `git rebase -i` to make history edits
11-
- Create a branch on the master, called release_<version>, make release edits there
12-
- Increase version number in iminuit/version.py
13-
- Update doc/changelog.rst
14-
- Check that all wheels are build (Azure should trigger)
15-
- Merge release branch to master
16+
- Check that all wheels are build and run fine
17+
- If there are problems with the wheels, create a beta/<release-version> branch and
18+
commit fixes there, once the problem is fixed, squash-merge the branch to master
1619
- Create release on Github
17-
- This triggers an upload of the latest build artefacts to PyPI
18-
- Note: a prerelease is published on TestPyPI, a release on PyPI
19-
- Upload uses API tokens configured in PyPI, TestPyPI, and Github "Secrets"
20-
- Conda-forge should pick this up automatically and generate conda packages
20+
- Message: [See changelog on RTD](https://iminuit.readthedocs.io/en/stable/changelog.html)
21+
- This triggers an upload of the latest build artefacts to PyPI
22+
- If this fails unexpectedly, download the artefact from the actions page and upload
23+
it manually with twine, then fix the issue for the next release
24+
- Upload uses API tokens configured in PyPI and Github "Secrets"
25+
- conda-forge should pick this up automatically and generate conda packages

0 commit comments

Comments
 (0)