How to do a release for Fail2Ban¶

Preparation¶

Check distribution patches and see if they can be included
Check distribution outstanding bugs
Make sure the tests pass:
```
./fail2ban-testcases-all
```
Ensure the version is correct in:
- ./fail2ban/version.py
- top of ChangeLog
- README.md
Ensure the MANIFEST is complete
Run:

python setup.py sdist

Look for errors like:

'testcases/files/logs/mysqld.log' not a regular file -- skipping

Which indicates that testcases/files/logs/mysqld.log has been moved or is a directory:
```
tar -C /tmp -jxf dist/fail2ban-0.9.0.tar.bz2
```

clean up current direcory:
```
diff -rul --exclude \*.pyc . /tmp/fail2ban-0.9.0/
```
- Only differences should be files that you don’t want distributed.

Ensure the tests work from the tarball:

cd /tmp/fail2ban-0.9.0/ && export PYTHONPATH=`pwd` && bin/fail2ban-testcases

Add/finalize the corresponding entry in the ChangeLog
- To generate a list of committers use e.g.:
```
git shortlog -sn 0.8.12.. | sed -e 's,^[ 0-9\t]*,,g' | tr '\n' '\|' | sed -e 's:|:, :g'
```
- Ensure the top of the ChangeLog has the right version and current date.
- Ensure the top entry of the ChangeLog has the right version and current date.

Update man pages:

(cd man ; ./generate-man )
git commit -m 'DOC/ENH: update man pages for release' man/*

Cleanout TODO file with the finished stuff
Prepare source and rpm binary distributions:
```
python setup.py sdist
```
- Broken for now: python setup.py bdist_rpm
- Broken for now: python setup.py upload
Tag the release by using a signed (and annotated) tag. Cut/paste release ChangeLog entry as tag annotation:
```
git tag -s 0.9.1
```

Pre Release¶

Provide a release sample to distributors
- Arch Linux:
  - https://www.archlinux.org/packages/community/any/fail2ban/
- Debian: Yaroslav Halchenko <debian@onerussian.com>
  - http://packages.qa.debian.org/f/fail2ban.html
- FreeBSD: Christoph Theis theis@gmx.at>, Nick Hilliard <nick@foobar.org>
  - http://svnweb.freebsd.org/ports/head/security/py-fail2ban/Makefile?view=markup
  - http://www.freebsd.org/cgi/query-pr-summary.cgi?text=fail2ban
- Fedora: Axel Thimm <Axel.Thimm@atrpms.net>
- Gentoo: netmon@gentoo.org
  - http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/net-analyzer/fail2ban/metadata.xml?view=markup
  - https://bugs.gentoo.org/buglist.cgi?quicksearch=fail2ban
- openSUSE: Stephan Kulow <coolo@suse.com>
  - https://build.opensuse.org/package/show/openSUSE:Factory/fail2ban
- Mac Ports: @Malbrouck on github (gh-49)
  - https://trac.macports.org/browser/trunk/dports/security/fail2ban/Portfile
- Mageia:
  - https://bugs.mageia.org/buglist.cgi?quicksearch=fail2ban
- An potentially to the fail2ban-users email list.
Wait for feedback from distributors
Prepare a release notice https://github.com/fail2ban/fail2ban/releases/new
Upload the source/binaries from the dist directory and tag the release using the URL
Upload source/binaries to sourceforge http://sourceforge.net/projects/fail2ban/
Run the following and update the wiki with output:
```
python -c 'import fail2ban.protocol; fail2ban.protocol.printWiki()'
```
- page: http://www.fail2ban.org/wiki/index.php/Commands
Update:
See if any filters are upgraded: http://www.fail2ban.org/wiki/index.php/Special:AllPages
Email users and development list of release
notify distributors

Post Release¶

Add the following to the top of the ChangeLog:

ver. 0.9.1 (2014/XX/XXX) - wanna-be-released
-----------

- Fixes:

- New Features:

- Enhancements:

Alter the git shortlog command in the previous section to refer to the just released version.

and adjust fail2ban/version.py to carry .dev suffix to signal a version under development.