2014-03-29 22:07:33 +00:00
|
|
|
.. __ _ _ ___ _
|
2014-03-15 07:45:49 +00:00
|
|
|
/ _|__ _(_) |_ ) |__ __ _ _ _
|
|
|
|
| _/ _` | | |/ /| '_ \/ _` | ' \
|
|
|
|
|_| \__,_|_|_/___|_.__/\__,_|_||_|
|
|
|
|
|
|
|
|
================================================================================
|
|
|
|
How to do a release for Fail2Ban
|
|
|
|
================================================================================
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
Preparation
|
|
|
|
===========
|
|
|
|
|
|
|
|
* Check distribution patches and see if they can be included
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
* https://apps.fedoraproject.org/packages/fail2ban/sources
|
|
|
|
* http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/net-analyzer/fail2ban/
|
|
|
|
* http://svnweb.freebsd.org/ports/head/security/py-fail2ban/
|
|
|
|
* https://build.opensuse.org/package/show?package=fail2ban&project=openSUSE%3AFactory
|
|
|
|
* http://sophie.zarb.org/sources/fail2ban (Mageia)
|
|
|
|
* https://trac.macports.org/browser/trunk/dports/security/fail2ban
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* Check distribution outstanding bugs
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
* https://github.com/fail2ban/fail2ban/issues?sort=updated&state=open
|
|
|
|
* http://bugs.debian.org/cgi-bin/pkgreport.cgi?dist=unstable;package=fail2ban
|
|
|
|
* https://bugs.launchpad.net/ubuntu/+source/fail2ban
|
|
|
|
* http://bugs.sabayon.org/buglist.cgi?quicksearch=net-analyzer%2Ffail2ban
|
|
|
|
* https://bugs.archlinux.org/?project=5&cat%5B%5D=33&string=fail2ban
|
|
|
|
* https://bugs.gentoo.org/buglist.cgi?query_format=advanced&short_desc=fail2ban&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&short_desc_type=allwords
|
|
|
|
* https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&component=fail2ban&classification=Red%20Hat&classification=Fedora
|
|
|
|
* http://www.freebsd.org/cgi/query-pr-summary.cgi?text=fail2ban
|
|
|
|
* https://bugs.mageia.org/buglist.cgi?quicksearch=fail2ban
|
|
|
|
* https://build.opensuse.org/package/requests/openSUSE:Factory/fail2ban
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* Make sure the tests pass::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
./fail2ban-testcases-all
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Ensure the version is correct in:
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
* ./fail2ban/version.py
|
|
|
|
* top of ChangeLog
|
|
|
|
* README.md
|
|
|
|
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Ensure the MANIFEST is complete
|
|
|
|
|
2014-10-28 01:27:51 +00:00
|
|
|
ad-hoc bash script to run in a clean clone:
|
|
|
|
|
|
|
|
find -type f | grep -v -e '\.git' -e '/doc/' -e '\.travis' -e MANIFEST | sed -e 's,^\./,,g' | while read f; do grep -ne "^$f\$" MANIFEST >/dev/null || echo "$f" ; done
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Run::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
python setup.py sdist
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Look for errors like::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
'testcases/files/logs/mysqld.log' not a regular file -- skipping
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Which indicates that testcases/files/logs/mysqld.log has been moved or is a directory::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
tar -C /tmp -jxf dist/fail2ban-0.9.2.tar.bz2
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* clean up current direcory::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
diff -rul --exclude \*.pyc . /tmp/fail2ban-0.9.2/
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Only differences should be files that you don't want distributed.
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Ensure the tests work from the tarball::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
cd /tmp/fail2ban-0.9.2/ && export PYTHONPATH=`pwd` && bin/fail2ban-testcases
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Add/finalize the corresponding entry in the ChangeLog
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* To generate a list of committers use e.g.::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
git shortlog -sn 0.9.2.. | sed -e 's,^[ 0-9\t]*,,g' | tr '\n' '\|' | sed -e 's:|:, :g'
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* 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.
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Update man pages::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
(cd man ; ./generate-man )
|
|
|
|
git commit -m 'DOC/ENH: update man pages for release' man/*
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Cleanout TODO file with the finished stuff
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Prepare source and rpm binary distributions::
|
|
|
|
|
|
|
|
python setup.py sdist
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Broken for now: python setup.py bdist_rpm
|
|
|
|
* Broken for now: python setup.py upload
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Tag the release by using a signed (and annotated) tag. Cut/paste
|
|
|
|
release ChangeLog entry as tag annotation::
|
2014-03-17 21:19:10 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
git tag -s 0.9.2
|
2014-03-17 21:19:10 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
Pre Release
|
|
|
|
===========
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Provide a release sample to distributors
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
* Arch Linux:
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* https://www.archlinux.org/packages/community/any/fail2ban/
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* Debian: Yaroslav Halchenko <debian@onerussian.com>
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* http://packages.qa.debian.org/f/fail2ban.html
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* FreeBSD: Christoph Theis theis@gmx.at>, Nick Hilliard <nick@foobar.org>
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* http://svnweb.freebsd.org/ports/head/security/py-fail2ban/Makefile?view=markup
|
|
|
|
* http://www.freebsd.org/cgi/query-pr-summary.cgi?text=fail2ban
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* Fedora: Axel Thimm <Axel.Thimm@atrpms.net>
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* https://apps.fedoraproject.org/packages/fail2ban
|
|
|
|
* http://pkgs.fedoraproject.org/cgit/fail2ban.git
|
|
|
|
* https://admin.fedoraproject.org/pkgdb/acls/bugs/fail2ban
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* Gentoo: netmon@gentoo.org
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* 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
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* openSUSE: Stephan Kulow <coolo@suse.com>
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* https://build.opensuse.org/package/show/openSUSE:Factory/fail2ban
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* Mac Ports: @Malbrouck on github (gh-49)
|
2014-03-29 22:07:33 +00:00
|
|
|
|
|
|
|
* https://trac.macports.org/browser/trunk/dports/security/fail2ban/Portfile
|
|
|
|
|
2014-03-15 07:45:49 +00:00
|
|
|
* Mageia:
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* https://bugs.mageia.org/buglist.cgi?quicksearch=fail2ban
|
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
* And potentially to the fail2ban-users email list.
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Wait for feedback from distributors
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Prepare a release notice https://github.com/fail2ban/fail2ban/releases/new
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Upload the source/binaries from the dist directory and tag the release using the URL
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* 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
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
|
|
|
|
* Update:
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* http://www.fail2ban.org/wiki/index.php?title=Template:Fail2ban_Versions&action=edit
|
|
|
|
|
|
|
|
* http://www.fail2ban.org/wiki/index.php?title=Template:Fail2ban_News&action=edit
|
|
|
|
* move old bits to http://www.fail2ban.org/wiki/index.php?title=Template:Fail2ban_OldNews&action=edit
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* http://www.fail2ban.org/wiki/index.php/ChangeLog
|
|
|
|
* http://www.fail2ban.org/wiki/index.php/Requirements (Check requirement)
|
|
|
|
* http://www.fail2ban.org/wiki/index.php/Features
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
* See if any filters are upgraded:
|
|
|
|
http://www.fail2ban.org/wiki/index.php/Special:AllPages
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* Email users and development list of release
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
* notify distributors
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
Post Release
|
|
|
|
============
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
Add the following to the top of the ChangeLog::
|
2014-03-15 07:45:49 +00:00
|
|
|
|
2014-10-28 03:45:51 +00:00
|
|
|
ver. 0.9.3 (2014/XX/XXX) - wanna-be-released
|
2014-03-29 22:07:33 +00:00
|
|
|
-----------
|
|
|
|
|
|
|
|
- Fixes:
|
|
|
|
|
|
|
|
- New Features:
|
|
|
|
|
|
|
|
- Enhancements:
|
2014-03-15 07:45:49 +00:00
|
|
|
|
|
|
|
Alter the git shortlog command in the previous section to refer to the just
|
|
|
|
released version.
|
|
|
|
|
2014-03-29 22:07:33 +00:00
|
|
|
and adjust fail2ban/version.py to carry .dev suffix to signal
|
2014-03-15 07:45:49 +00:00
|
|
|
a version under development.
|