summaryrefslogtreecommitdiff
path: root/RELEASE.md
diff options
context:
space:
mode:
authorJulien (jvoisin) Voisin2016-08-12 11:29:48 +0200
committerJulien (jvoisin) Voisin2016-08-12 11:29:48 +0200
commitc22aab535dccf6613f57826eb1bda0c980ce06dd (patch)
tree2fe328b41c2c4d1212dd49b14512435d64e26973 /RELEASE.md
parenta16626851b70c483199783826c29aca6c4400958 (diff)
Improves a bit the release process
Diffstat (limited to 'RELEASE.md')
-rw-r--r--RELEASE.md28
1 files 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 @@
1# PHP Malware Finder release documentation 1# PHP Malware Finder release documentation
2 2
3## What should I do before releasing ? 3## What should I do before releasing?
4 4
5Thou shalt test your modifications. If everything goes fine, you should see this 5Thou shalt test your modifications. If everything goes fine, you should see this
6message: 6message:
7
7``` 8```
8$ ./tests.sh 9$ make test
9[+] Congratz, the 54 tests succeeded! 10[+] Congratz, the XX tests succeeded!
10``` 11```
11 12
12Otherwise, your modifications introduced a regression, check how to fix this, 13Otherwise, your modifications introduced a regression, fix them,
13then test again until all tests pass. 14then **test again** until all tests are passing.
14 15
15## OK, it's done, how do I release my new PMF version now ? 16## OK, it's done, how do I release my new PMF version now?
16 17
17First, make sure enough modifications have been made to warrant a new release. 18First, make sure enough modifications have been made to warrant a new release.
18Since PMF provides its own debian package files, you can build a package, 19Since PMF provides its own debian package files, you may build a package,
19hence need to modify the changelog file to add an entry in the debian/changelog 20hence the need to modify the changelog file to add an entry in the
20file: 21`debian/changelog` file:
22
23You should use the `dch -i` command instead of editing the changelog by hand,
24but if you don't have it installed, you can add something like this:
21 25
22``` 26```
23nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX 27nbs-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
30``` 34```
31 35
32Then you can commit on our git repository: 36Then you can commit on our git repository:
37
33``` 38```
34$ git commit -am "my changes" 39$ git commit -am "X.Y.Z"
35$ git tag X.Y.Z 40$ git tag X.Y.Z
36$ git push --tags 41$ git push --tags
37``` 42```
38 43
44Do not forget to update the [milestones on github](
45https://github.com/nbs-system/php-malware-finder/milestones ).
46