|
| 1 | +Maintainer Cheatsheet |
| 2 | +===================== |
| 3 | + |
| 4 | +## Making a new release |
| 5 | + |
| 6 | +1. Make sure your tree is in sync with the mothership |
| 7 | + |
| 8 | + ``` |
| 9 | + git fetch |
| 10 | + git checkout master && git pull |
| 11 | + git checkout release/v1 && git pull |
| 12 | + ``` |
| 13 | +
|
| 14 | +2. Merge `master` into `release/v1` |
| 15 | +
|
| 16 | + ``` |
| 17 | + git merge master --no-commit |
| 18 | + vim package.json package-lock.json # update "version" |
| 19 | + npm ci --omit=dev |
| 20 | + git add node_modules |
| 21 | + git commit -p -m "setup-nasm v1.X.X" |
| 22 | + ``` |
| 23 | +
|
| 24 | +3. Tag and sign the release |
| 25 | +
|
| 26 | + ``` |
| 27 | + git tag --sign v1.X.X |
| 28 | + ``` |
| 29 | +
|
| 30 | + Tag comment looks like this: |
| 31 | + ``` |
| 32 | + setup-nasm v1.5.0 |
| 33 | +
|
| 34 | + - Update default NASM to 2.16.01 |
| 35 | + ``` |
| 36 | +
|
| 37 | +4. Push the new tag and `release/v1` branch |
| 38 | +
|
| 39 | + ``` |
| 40 | + git push origin release/v1 v1.X.X |
| 41 | + ``` |
| 42 | +
|
| 43 | + Visit and check that it looks okay and CI passes: |
| 44 | +
|
| 45 | + * https://github.com/ilammy/setup-nasm/tree/release/v1 |
| 46 | + * https://github.com/ilammy/setup-nasm/tags |
| 47 | +
|
| 48 | +5. Draft the release notes |
| 49 | +
|
| 50 | + Visit and prepare a draft |
| 51 | +
|
| 52 | + * https://github.com/ilammy/setup-nasm/releases/new |
| 53 | +
|
| 54 | + Release title and comment look like this |
| 55 | +
|
| 56 | + ```markdown |
| 57 | + setup-nasm v1.5.0 |
| 58 | +
|
| 59 | + * Update package-lock.json (https://github.com/ilammy/setup-nasm/pull/39) |
| 60 | + * Update default nasm version (https://github.com/ilammy/setup-nasm/pull/38) |
| 61 | +
|
| 62 | + New contributors: |
| 63 | +
|
| 64 | + * @Brooooooklyn |
| 65 | + ``` |
| 66 | +
|
| 67 | + Click the `[Save draft]` button |
| 68 | +
|
| 69 | + Check how it looks in https://github.com/ilammy/setup-nasm/releases |
| 70 | +
|
| 71 | +6. Publish the release |
| 72 | +
|
| 73 | + Press the `[Publish release]` button |
| 74 | +
|
| 75 | + Check how it looks in https://github.com/ilammy/setup-nasm/releases |
| 76 | +
|
| 77 | +7. Push the updated `v1` tag alias |
| 78 | +
|
| 79 | + ``` |
| 80 | + git tag --force v1 v1.X.X |
| 81 | + git push --force origin v1 |
| 82 | + ``` |
0 commit comments