diff options
| author | Julien (jvoisin) Voisin | 2016-08-12 11:29:48 +0200 |
|---|---|---|
| committer | Julien (jvoisin) Voisin | 2016-08-12 11:29:48 +0200 |
| commit | c22aab535dccf6613f57826eb1bda0c980ce06dd (patch) | |
| tree | 2fe328b41c2c4d1212dd49b14512435d64e26973 /RELEASE.md | |
| parent | a16626851b70c483199783826c29aca6c4400958 (diff) | |
Improves a bit the release process
Diffstat (limited to 'RELEASE.md')
| -rw-r--r-- | RELEASE.md | 28 |
1 files changed, 18 insertions, 10 deletions
| @@ -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 | ||
| 5 | Thou shalt test your modifications. If everything goes fine, you should see this | 5 | Thou shalt test your modifications. If everything goes fine, you should see this |
| 6 | message: | 6 | message: |
| 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 | ||
| 12 | Otherwise, your modifications introduced a regression, check how to fix this, | 13 | Otherwise, your modifications introduced a regression, fix them, |
| 13 | then test again until all tests pass. | 14 | then **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 | ||
| 17 | First, make sure enough modifications have been made to warrant a new release. | 18 | 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 | Since PMF provides its own debian package files, you may build a package, |
| 19 | hence need to modify the changelog file to add an entry in the debian/changelog | 20 | hence the need to modify the changelog file to add an entry in the |
| 20 | file: | 21 | `debian/changelog` file: |
| 22 | |||
| 23 | You should use the `dch -i` command instead of editing the changelog by hand, | ||
| 24 | but if you don't have it installed, you can add something like this: | ||
| 21 | 25 | ||
| 22 | ``` | 26 | ``` |
| 23 | nbs-phpmalwarefinder (X.Y.Z-T~deb##version+nbsYYYMMDD) distrib; urgency=XXX | 27 | 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 | |||
| 30 | ``` | 34 | ``` |
| 31 | 35 | ||
| 32 | Then you can commit on our git repository: | 36 | Then 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 | ||
| 44 | Do not forget to update the [milestones on github]( | ||
| 45 | https://github.com/nbs-system/php-malware-finder/milestones ). | ||
| 46 | |||
