Skip to content

Commit

Permalink
expanded this document a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
tobixen committed Dec 19, 2023
1 parent 70e7856 commit 0e99d2a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions RELEASE-HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,17 @@ I have no clue on the proper procedures for doing releases, and I keep on doing
python -m build
python -m twine upload dist/*
```
* Remove the release dir: `rm -r caldav-release`

## List of mistakes to be avoided

This is most likely not complete, but should explain some of the "silly" steps above ...

* Forgetting to set a release git tag
* Forgetting to update the version number (or setting it wrongly) - but now `setuptools-scm` is supposed to take care of that)
* Doing last-minute changes in i.e. `CHANGELOG.md` causing the style test to break
* Forgetting to add new files to the git repo
* Having checked out a branch or tag or something, and tagging that as the new release rather than the latest HEAD.
* Forgetting to push to pypi, or pushing something else than the tagged revision to pypi
* Pushing out junk files in the pypi-release (i.e. .pyc-files, log files, temp files, `tests/conf_private.py`, etc
* Not adding the release to the "github releases" (I don't care much about this feature, but apparently some people check there to find the latest release version)

0 comments on commit 0e99d2a

Please sign in to comment.