From c22aab535dccf6613f57826eb1bda0c980ce06dd Mon Sep 17 00:00:00 2001 From: Julien (jvoisin) Voisin Date: Fri, 12 Aug 2016 11:29:48 +0200 Subject: Improves a bit the release process --- RELEASE.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 48ad492..ebca62f 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,23 +1,27 @@ # PHP Malware Finder release documentation -## What should I do before releasing ? +## What should I do before releasing? Thou shalt test your modifications. If everything goes fine, you should see this message: + ``` -$ ./tests.sh -[+] Congratz, the 54 tests succeeded! +$ make test +[+] Congratz, the XX tests succeeded! ``` -Otherwise, your modifications introduced a regression, check how to fix this, -then test again until all tests pass. +Otherwise, your modifications introduced a regression, fix them, +then **test again** until all tests are passing. -## OK, it's done, how do I release my new PMF version now ? +## OK, it's done, how do I release my new PMF version now? First, make sure enough modifications have been made to warrant a new release. -Since PMF provides its own debian package files, you can build a package, -hence need to modify the changelog file to add an entry in the debian/changelog -file: +Since PMF provides its own debian package files, you may build a package, +hence the need to modify the changelog file to add an entry in the +`debian/changelog` file: + +You should use the `dch -i` command instead of editing the changelog by hand, +but if you don't have it installed, you can add something like this: ``` nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX @@ -30,9 +34,13 @@ nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX ``` Then you can commit on our git repository: + ``` -$ git commit -am "my changes" +$ git commit -am "X.Y.Z" $ git tag X.Y.Z $ git push --tags ``` +Do not forget to update the [milestones on github]( +https://github.com/nbs-system/php-malware-finder/milestones ). + -- cgit v1.3