contrib/release/README

   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 --sign -m 'Release vX.Y' 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. Run pkgtest.py
  30
  31    - Use options to test supported Python versions
  32    - Spot-check output
  33
  34 5. Update stacked-git.github.io
  35
  36    - In stacked-git.github.io repo, `make sync` to sync updated
  37      changelog and man pages into website.
  38    - Review home page for anything that should be updated in conjunction
  39      with the StGit release.
  40
  41 6. Push changes upstream
  42
  43    - Push new tag and master branch upstream
  44    - Push stacked-git.github.io changes
  45
  46 7. Create GitHub release
  47
  48    - Use "Stacked Git X.Y" for release title.
  49    - Write a sentence or two description of release.
  50    - Paste this versions changes from CHANGELOG.md.
  51    - Upload source dist file (`stgit-X.Y.tar.gz`).
  52
  53 8. Send notifications
  54
  55    - Post a new discussion on GitHub repo
  56    - ...
  57
  58 9. Review and update these release instructions