summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--doc/howto-publish-a-release.md49
-rw-r--r--doc/howto-publish-a-release.txt39
2 files changed, 49 insertions, 39 deletions
diff --git a/doc/howto-publish-a-release.md b/doc/howto-publish-a-release.md
new file mode 100644
index 00000000..402d7b29
--- /dev/null
+++ b/doc/howto-publish-a-release.md
@@ -0,0 +1,49 @@
+Test everything
+----------------
+- [ ] `make test`
+- [ ] `./ranger.py [--clean]`
+- [ ] `ranger/ext/rifle.py`
+- [ ] `make install`
+
+Make a release commit
+---------------------
+- [ ] Update the number in the `README`
+- [ ] Update `__version__` and `VERSION` in `ranger/__init__.py`
+- [ ] Update `__version__` in `ranger/ext/rifle.py`
+- [ ] `make man`
+- [ ] Write changelog entry
+- [ ] Think of a witty commit message
+- [ ] Push the commit
+
+Make snapshot and test again
+----------------------------
+- [ ] Build `.tar.gz` with `make snapshot`
+- [ ] `make`
+- [ ] `make install`
+- [ ] Test the snapshot one last time
+
+Update the website
+------------------
+- [ ] Add the new version as `ranger-stable.tar.gz`
+- [ ] Add the new version as `ranger-X.Y.Z.tar.gz`
+- [ ] Update both signatures `gpg --local-user 0x00FB5CDF --sign --detach-sign <file>`
+- [ ] Update the changelog
+- [ ] Update the man page
+- [ ] Rerun `boobies.py`
+
+Make a PyPI release
+-------------------
+- [ ] `git clean --force -d -x`
+- [ ] `python setup.py sdist`
+- [ ] `gpg --local-user 0x00000000 --detach-sign --armor dist/*`
+- [ ] `twine upload dist/*`
+
+Announce the update
+-------------------
+- [ ] To the mailing list
+- [ ] In the arch linux forum
+- [ ] Write a news entry on savannah
+
+Change back to before
+---------------------
+- [ ] Change `VERSION` in `ranger/__init__.py` back to `master`
diff --git a/doc/howto-publish-a-release.txt b/doc/howto-publish-a-release.txt
deleted file mode 100644
index 089a3343..00000000
--- a/doc/howto-publish-a-release.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-( ) test everything one last time:
-(x) * make test
-(x) * ./ranger.py [--clean]
-( ) * ranger/ext/rifle.py
-( ) * make install
-
-( ) make a release commit:
-( ) * update the number in the README
-( ) * update __version__ and VERSION in ranger/__init__.py
-( ) * update __version__ in ranger/ext/rifle.py
-( ) * make man
-( ) * write changelog entry
-( ) * think of a witty commit message
-( ) * push the commit
-
-( ) make a PyPI release:
-( ) * `git clean --force -d -x`
-( ) * `python setup.py sdist`
-( ) * `gpg --default-key 'YOUREMAIL' --detach-sign --armor dist/*`
-( ) * `twine upload dist/*`
-
-( ) build .tar.gz with "make snapshot"
-
-( ) make, make install and test the snapshot one last time
-
-( ) update the website:
-( ) * add the new version as ranger-stable.tar.gz
-( ) * add the new version as ranger-X.Y.Z.tar.gz
-( ) * update both signatures (gpg -u 0x00FB5CDF -sb <file>)
-( ) * update the changelog
-( ) * update the man page
-( ) * rerun boobies.py
-
-( ) announce the update
-( ) * to the mailing list
-( ) * in the arch linux forum
-( ) * write a news entry on savannah
-
-( ) Change VERSION in ranger/__init__.py back to `master`