|
1 |
| -This directory contains some of the scripts used for updating the |
2 |
| -public StGIT repository and releasing snapshots and main versions. |
| 1 | +StGit Release Checklist |
| 2 | +======================= |
| 3 | + |
| 4 | +0. Test |
| 5 | + |
| 6 | + - All functional tests should be passing (`make test`) |
| 7 | + - All lints should be passing (`make lint`) |
| 8 | + |
| 9 | +1. Update CHANGELOG.md |
| 10 | + |
| 11 | + - Look at git log from last release to HEAD. Identify user-facing |
| 12 | + changes, but ignore internal-only changes such as refactorings. |
| 13 | + - Add changes to *Removed*, *Added*, *Changed*, and *Fixed* lists in |
| 14 | + CHANGELOG.md. |
| 15 | + - Change "[Unreleased]" to reflect new release version and date. |
| 16 | + - Commit updated CHANGELOG.md |
| 17 | + |
| 18 | +2. Create new tag |
| 19 | + |
| 20 | + - `git tag -a -m 'Relase vX.Y'` |
| 21 | + |
| 22 | +3. Check source distribution |
| 23 | + |
| 24 | + - Create source distribution with `make dist`. |
| 25 | + - Find source dist file in `dist/`. |
| 26 | + - Make sure correct version is in dist filename. |
| 27 | + - Spot-check dist contents for any extra or missing files. |
| 28 | + |
| 29 | +4. Update stacked-git.github.io |
| 30 | + |
| 31 | + - In stacked-git.github.io repo, `make sync` to sync updated |
| 32 | + changelog and man pages into website. |
| 33 | + - Review home page for anything that should be updated in conjunction |
| 34 | + with the StGit release. |
| 35 | + |
| 36 | +5. Push changes upstream |
| 37 | + |
| 38 | + - Push new tag and master branch upstream |
| 39 | + - Push stacked-git.github.io changes |
| 40 | + |
| 41 | +6. Create GitHub release |
| 42 | + |
| 43 | + - Use "Stacked Git X.Y" for relase title. |
| 44 | + - Write a sentence or two description of release. |
| 45 | + - Paste this versions changes from CHANGELOG.md. |
| 46 | + - Upload source dist file (`stgit-X.Y.tar.gz`). |
| 47 | + |
| 48 | +7. Send notifications |
| 49 | + |
| 50 | + - Post a new discussion on GitHub repo |
| 51 | + - ... |
| 52 | + |
| 53 | +8. Review and update these release instructions |
0 commit comments