Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 2.77 KB

RELEASE.md

File metadata and controls

95 lines (73 loc) · 2.77 KB
Raw

Releasing new versions of Git Town

This guide is for maintainers who make releases of Git Town.

  • in a branch:
    • update CHANGELOG.md
    • run make stats-release and copy the release stats and contributors into CHANGELOG.md
    • verify that all newly added Git Town commands are not hidden
    • verify that the website content reflects all the changes made
    • search-and-replace the old version with the new version
      • triple-digits: 14.2.0
      • double-digits: 14.2
      • don't change existing version numbers in CHANGELOG.md
    • if bumping the major version:
      • update github.com/git-town/git-town/v14/ everywhere in this repo
      • update github.com/git-town/git-town/v14 (without trailing slash)
  • ship the branch
  • git tag v14.2.0 && git push --tags
  • open the new release in the browser
  • copy the changelog into the release notes
  • publish the release
  • merge the main branch into the public branch

update the website

The website publishes from the public branch to avoid listing unreleased features to the public.

git checkout public
git merge main
git push

debugging the release script

Debugging is best done on a separate fork of this codebase. This avoids accidental releases to the official location, which then trigger other automation at Homebrew, Scoop, Arch Linux, etc.

The release script is written in PowerShell because creating the .msi file requires Windows. It's best to debug it on a Windows machine.

Test the compile step:

.\rta goreleaser@1.22.1 --snapshot --skip-publish --clean

Test the entire release pipeline:

  • this MUST happen in a separate repo
git push ; git tag -d v0.0.1 ; git push origin :v0.0.1 ; git tag v0.0.1 ; git push --tags
$env:GITHUB_TOKEN="<github token>"; $env:VERSION="0.0.1"; $env:TODAY="today"; .\tools\release.ps1

performing a manual release

If the release script fails in production and doesn't create the release, and/or you want to investigate some release code, you can perform the release manually on a Windows machine using PowerShell.

  • move the affected Git tag to HEAD but only locally, DON'T PUSH THE TAG TO ORIGIN

    git tag -d <tag>
git tag <tag>

  • run the release script

    $env:GITHUB_TOKEN="<token>"
$env:CHOCOLATEY_API_KEY="<key>"
.\tools\release.ps1

  • delete the local Git tag and download the real one from origin

    git tag -d <tag>
git fetch --tags

release platforms