diff options
| -rw-r--r-- | RELEASE.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..a1f67c0 --- /dev/null +++ b/RELEASE.md | |||
| @@ -0,0 +1,38 @@ | |||
| 1 | # PHP Malware Finder release documentation | ||
| 2 | |||
| 3 | ## What should I do before releasing ? | ||
| 4 | |||
| 5 | Thou shalt test your modifications. If everything goes fine, you should see this | ||
| 6 | message: | ||
| 7 | ``` | ||
| 8 | $ ./tests.sh | ||
| 9 | [+] Congratz, the 54 tests succeeded! | ||
| 10 | ``` | ||
| 11 | |||
| 12 | Otherwise, your modifications introduced a regression, check how to fix this, | ||
| 13 | then test again until all tests pass. | ||
| 14 | |||
| 15 | ## OK, it's done, how do I release my new PMF version now ? | ||
| 16 | |||
| 17 | First, make sure enough modifications have been made to warrant a new release. | ||
| 18 | Since PMF provides its own debian package files, you can build a package, | ||
| 19 | hence need to modify the changelog file to add an entry in the debian/changelog | ||
| 20 | file: | ||
| 21 | |||
| 22 | ``` | ||
| 23 | nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX | ||
| 24 | |||
| 25 | * new feature | ||
| 26 | * bug fix | ||
| 27 | * moar documentation | ||
| 28 | |||
| 29 | -- yournick <your@email.com> `date -R` | ||
| 30 | ``` | ||
| 31 | |||
| 32 | Then you can commit on our git repository: | ||
| 33 | ``` | ||
| 34 | $ git commit -am "my changes" | ||
| 35 | $ git tag X.Y.Z | ||
| 36 | $ git push | ||
| 37 | ``` | ||
| 38 | |||
