| 1 |
# How to do a uchardet release # |
| 2 |
|
| 3 |
* Update UCHARDET_VERSION_MAJOR, UCHARDET_VERSION_MINOR and |
| 4 |
UCHARDET_VERSION_REVISION as needed in CMakeLists.txt. |
| 5 |
|
| 6 |
* Update README.md. |
| 7 |
|
| 8 |
* Commit the version change with the message "Release: version X.Y.Z." |
| 9 |
|
| 10 |
* Tag your release commit with: |
| 11 |
|
| 12 |
git tag -a vx.y.z |
| 13 |
|
| 14 |
The tag message should be have the header "Version x.y.z released." followed |
| 15 |
by a list of new features or important fixes. This tag message will be |
| 16 |
considered as the release note, hence have to be carefully crafted. |
| 17 |
|
| 18 |
Considering that the previous release was va.b.c, you can read the full list |
| 19 |
of commits between a.b.c and x.y.z with: |
| 20 |
|
| 21 |
git log va.b.c.. |
| 22 |
|
| 23 |
This should help you to build a proper release note. |
| 24 |
|
| 25 |
* Push the release and the tag: |
| 26 |
|
| 27 |
git push |
| 28 |
git push origin vx.y.z |
| 29 |
|
| 30 |
* Create a release tarball: |
| 31 |
|
| 32 |
git archive --format=tar.xz --prefix=uchardet-x.y.z/ vx.y.z >uchardet-x.y.z.tar.xz |
| 33 |
|
| 34 |
Note: if you have not already set this up, you have to run first: |
| 35 |
|
| 36 |
git config tar.tar.xz.command "xz -c" |
| 37 |
|
| 38 |
Cf. EXAMPLES section in `git help archive`. |
| 39 |
|
| 40 |
* Compute a SHA1 checksum: |
| 41 |
|
| 42 |
sha1sum uchardet-x.y.x.tar.xz > uchardet-x.y.z.tar.xz.sha1 |
| 43 |
|
| 44 |
* Upload to annarchy download server: |
| 45 |
|
| 46 |
scp uchardet-x.y.x.tar.xz uchardet-x.y.z.tar.xz.sha1 annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/uchardet/releases/ |
| 47 |
|
| 48 |
The archive and its checksum file should now be available from: |
| 49 |
https://www.freedesktop.org/software/uchardet/releases/ |
| 50 |
|
| 51 |
* Make the git tag into a Gitlab release (not automatic). |
| 52 |
It will be found at: https://gitlab.freedesktop.org/uchardet/uchardet/-/tags/vx.y.z |
| 53 |
Just click the "Edit release notes" button, and copy paste the tag comment as "release notes". |
| 54 |
|
| 55 |
* Update the wiki page: https://www.freedesktop.org/wiki/Software/uchardet/ |
| 56 |
The release note link will be: |
| 57 |
https://gitlab.freedesktop.org/uchardet/uchardet/-/releases/vx.y.z |
| 58 |
|
| 59 |
* Spread the good news! |