|
| 1 | +Release procedure |
| 2 | +==================== |
| 3 | + |
| 4 | +Release candidate versions |
| 5 | +--- |
| 6 | + |
| 7 | + 1. Make sure release notes in `NEWS` are up to date. |
| 8 | + |
| 9 | + 2. Run the tests one more time: |
| 10 | + |
| 11 | + ``` |
| 12 | + $ ./gradlew clean check |
| 13 | + ``` |
| 14 | +
|
| 15 | + 3. Tag the head commit with an `X.Y.Z-RCN` tag: |
| 16 | +
|
| 17 | + ``` |
| 18 | + $ git tag -a -s 1.4.0-RC1 -m "Pre-release 1.4.0-RC1" |
| 19 | + ``` |
| 20 | +
|
| 21 | + No tag body needed. |
| 22 | +
|
| 23 | + 4. Publish to Sonatype Nexus: |
| 24 | +
|
| 25 | + ``` |
| 26 | + $ ./gradlew publish closeAndReleaseRepository |
| 27 | + ``` |
| 28 | +
|
| 29 | + 5. Push to GitHub: |
| 30 | +
|
| 31 | + ``` |
| 32 | + $ git push origin master 1.4.0-RC1 |
| 33 | + ``` |
| 34 | +
|
| 35 | + 6. Make GitHub release. |
| 36 | +
|
| 37 | + - Use the new tag as the release tag |
| 38 | + - Check the pre-release checkbox |
| 39 | + - Copy the release notes from `NEWS` into the GitHub release notes; reformat |
| 40 | + from ASCIIdoc to Markdown and remove line wraps. Include only |
| 41 | + changes/additions since the previous release or pre-release. |
| 42 | + - Attach the signature files from |
| 43 | + `webauthn-server-attestation/build/libs/webauthn-server-attestation-X.Y.Z-RCN.jar.asc` |
| 44 | + and |
| 45 | + `webauthn-server-core/build/libs/webauthn-server-core-X.Y.Z-RCN.jar.asc`. |
| 46 | + - Note which JDK version was used to build the artifacts. |
| 47 | +
|
| 48 | +
|
| 49 | +Release versions |
| 50 | +--- |
| 51 | +
|
| 52 | + 1. Make sure release notes in `NEWS` are up to date. |
| 53 | +
|
| 54 | + 2. Make a no-fast-forward merge from the last (non release candidate) release |
| 55 | + to the commit to be released: |
| 56 | +
|
| 57 | + ``` |
| 58 | + $ git checkout 1.3.0 |
| 59 | + $ git checkout -b release-1.4.0 |
| 60 | + $ git merge --no-ff master |
| 61 | + ``` |
| 62 | +
|
| 63 | + Copy the release notes for this version from `NEWS` into the merge commit |
| 64 | + message; reformat it from ASCIIdoc to Markdown and re-wrap line widths at |
| 65 | + the conventional 72 columns (see |
| 66 | + [this](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 67 | + and [this](https://chris.beams.io/posts/git-commit/)). See previous release |
| 68 | + commits for examples. |
| 69 | +
|
| 70 | + ``` |
| 71 | + $ git checkout master |
| 72 | + $ git merge --ff-only release-1.4.0 |
| 73 | + $ git branch -d release-1.4.0 |
| 74 | + ``` |
| 75 | +
|
| 76 | + 3. Remove the "(unreleased)" tag from `NEWS`. |
| 77 | +
|
| 78 | + 4. Amend this change into the merge commit: |
| 79 | +
|
| 80 | + ``` |
| 81 | + $ git add NEWS |
| 82 | + $ git commit --amend --reset-author |
| 83 | + ``` |
| 84 | +
|
| 85 | + 5. Run the tests one more time: |
| 86 | +
|
| 87 | + ``` |
| 88 | + $ ./gradlew clean check |
| 89 | + ``` |
| 90 | +
|
| 91 | + 6. Tag the merge commit with an `X.Y.Z` tag: |
| 92 | +
|
| 93 | + ``` |
| 94 | + $ git tag -a -s 1.4.0 -m "Release 1.4.0" |
| 95 | + ``` |
| 96 | +
|
| 97 | + No tag body needed since that's included in the commit. |
| 98 | +
|
| 99 | + 7. Publish to Sonatype Nexus: |
| 100 | +
|
| 101 | + ``` |
| 102 | + $ ./gradlew publish closeAndReleaseRepository |
| 103 | + ``` |
| 104 | +
|
| 105 | + 8. Push to GitHub: |
| 106 | +
|
| 107 | + ``` |
| 108 | + $ git push origin master 1.4.0 |
| 109 | + ``` |
| 110 | +
|
| 111 | + 9. Make GitHub release. |
| 112 | +
|
| 113 | + - Use the new tag as the release tag |
| 114 | + - Copy the release notes from `NEWS` into the GitHub release notes; reformat |
| 115 | + from ASCIIdoc to Markdown and remove line wraps. Include all changes since |
| 116 | + the previous release (not just changes since the previous pre-release). |
| 117 | + - Attach the signature files from |
| 118 | + `webauthn-server-attestation/build/libs/webauthn-server-attestation-X.Y.Z.jar.asc` |
| 119 | + and `webauthn-server-core/build/libs/webauthn-server-core-X.Y.Z.jar.asc`. |
| 120 | + - Note which JDK version was used to build the artifacts. |
0 commit comments