doc/howto-publish-a-release.md

   1 Prepare the "stable" branch
   2 ---------------------------
   3 Before you can do anything else, you need to decide what should be included in
   4 the new version.
   5
   6 **Bugfix releases** bump the third number of the version, e.g. 1.9.0 -> 1.9.1.
   7 They may include bugfix commits that you `git cherry-pick`ed from the master
   8 branch into the stable branch, or you can just do a fast-forward merge of
   9 master into stable, if there were only bugfix commits since the last major
  10 version.  You can also add minor new features that are very likely not causing
  11 any bugs.  However, there should be absolutely **no** backward-incompatible
  12 changes, like:
  13
  14 - renamed or removed settings, commands or python functions
  15 - renamed, removed or reordered function arguments
  16 - change in syntax of configuration files or in API of configuration scripts
  17
  18 New settings are okay, just make sure a sane default value is defined.
  19
  20 **Major releases** bump the second number of the version, e.g. 1.9.2 -> 1.10.0
  21 and are necessary if you introduce any breaking changes, like the ones
  22 mentioned in the list above.
  23
  24 Test everything
  25 ----------------
  26 * [ ] `make test`
  27 * [ ] `./ranger.py [--clean]`
  28 * [ ] `ranger/ext/rifle.py`
  29 * [ ] `make install`
  30
  31 Make a release commit
  32 ---------------------
  33 * [ ] Update the number in the `README`
  34 * [ ] Update `__version__` and `__release__` in `ranger/__init__.py`
  35 * [ ] Update `__version__` in `ranger/ext/rifle.py`
  36 * [ ] `make man`
  37 * [ ] Write changelog entry
  38 * [ ] Think of a witty commit message
  39 * [ ] Commit
  40 * [ ] Tag the signed release with `git tag -as vX.Y.Z`, using the same
  41       commit message as annotation
  42 * [ ] Push release and tag
  43
  44 Make snapshot and test again
  45 ----------------------------
  46 * [ ] Build `.tar.gz` with `make snapshot`
  47 * [ ] `make`
  48 * [ ] `make install`
  49 * [ ] Test the snapshot one last time
  50
  51 Update the website
  52 ------------------
  53 * [ ] Add the new version as `ranger-stable.tar.gz`
  54 * [ ] Add the new version as `ranger-X.Y.Z.tar.gz`
  55 * [ ] Update both signatures `gpg --local-user 0x00FB5CDF --sign --detach-sign <file>`
  56 * [ ] Update the man page
  57     * [ ] run `make manhtml` in ranger's repository
  58     * [ ] copy the generated `doc/ranger.1.html` to the `ranger.github.io` repository
  59 * [ ] Rebuild the website, see `README.md` in https://github.com/ranger/ranger.github.io
  60 * [ ] Commit & push the website
  61
  62 Make a PyPI release
  63 -------------------
  64 * [ ] `git clean --force -d -x`
  65 * [ ] `SETUPTOOLS_USE=1 python setup.py sdist`
  66 * [ ] `gpg --local-user 0x00000000 --detach-sign --armor dist/*`
  67 * [ ] `twine upload dist/*`
  68
  69 Announce the update
  70 -------------------
  71 * [ ] To the mailing list
  72 * [ ] In the arch linux forum
  73
  74 Change back to before
  75 ---------------------
  76 * [ ] Change `__release__` in `ranger/__init__.py` back to `False`