hugo-theme-relearn/RELEASE.md
2021-08-28 12:21:22 +02:00

1 KiB

Releasing

We are using gren to generate the changelog and release notes automatically.

Once:

  • Generate API Token as described in gren's README.md
  • On Windows do setx GREN_GITHUB_TOKEN <API TOKEN> and restart your shell

Per release:

  • Close all issues of the milestone or push them back to an open milestone

  • Close the milestone

  • Tag and push the repo

    git tag --message "" <tag>
    git push origin <tag>
    
  • Regenerate CHANGELOG.md with gren

    npx github-release-notes@0.17.1 changelog --generate --override --tags=all
    
  • Add the changelog to git and update the tag

    git add exampleSite/content/basics/CHANGELOG.md
    git commit --message "Ship tag <tag>"
    git push origin main
    git tag --message "" --force <tag>
    git push --force origin <tag>
    
  • Generate release with gren

    npx github-release-notes@0.17.1 release --tags <tag>