From 989fc06a420a6f8f356c13d9a68a3173dcd39889 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Fri, 22 Mar 2013 09:26:33 -0400 Subject: [PATCH] DOC: DEVELOP -- mention TST commit tag, adjust formatting in Releasing --- DEVELOP | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/DEVELOP b/DEVELOP index 09bf7277..623aee12 100644 --- a/DEVELOP +++ b/DEVELOP @@ -44,7 +44,7 @@ coverage html Then look at htmlcov/index.html and see how much coverage your test cases exert over the codebase. Full coverage is a good thing however it may not be -complete. Try to ensure tests cover as many independant paths through the +complete. Try to ensure tests cover as many independent paths through the code. Manual Execution. To run in a development environment do: @@ -67,7 +67,7 @@ status test Coding Standards -================ +================ Style ----- @@ -106,9 +106,12 @@ Git Use the following tags in your commit messages: -'ENH:' for enhancements 'BF:' for bug fixes 'DOC:' for documentation fixes +'ENH:' for enhancements +'TST:' for commits concerning tests only (thus not touching the main code-base) + +Multiple tags could be joined with +, e.g. "BF+TST:". Adding Actions -------------- @@ -246,24 +249,30 @@ Takes care about executing start/check/ban/unban/stop commands Releasing ========= -Ensure the version is correct in ./common/version.py +# Ensure the version is correct in ./common/version.py + +# Add/finalize the corresponding entry in the ChangeLog + +# Update man pages + + (cd man ; ./generate-man ) + git commit -m 'update man pages for release' man/* -Add/finalize the corresponding entry in the ChangeLog +# Make sure the tests pass -# update man pages -(cd man ; ./generate-man ) + ./fail2ban-testcases-all -git commit -m 'update man pages for release' man/* +# Prepare/upload source and rpm binary distributions -python setup.py check -python setup.py sdist -python setup.py bdist_rpm -python setup.py upload + python setup.py check + python setup.py sdist + python setup.py bdist_rpm + python setup.py upload -Run the following and update the wiki with output: +# Run the following and update the wiki with output: -python -c 'import common.protocol; common.protocol.printWiki()' + python -c 'import common.protocol; common.protocol.printWiki()' -email users and development list of release +# Email users and development list of release TODO notifying distributors etc.