STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #10116 from cli/andyfeller/10113-update-release-docs

Browse source 
Update releasing.md
This commit is contained in:
William Martin 2024-12-23 19:48:31 +01:00 • committed by GitHub
commit b476849331
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/releasing.md
View file

@ -17,7 +17,7 @@ What this does is:
- A new git tag `vX.Y.Z` is created in the remote repository;
- The changelog is [generated from the list of merged pull requests](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes);
- Updates cli.github.com with the contents of the new release;
- Updates our Homebrew formula in the homebrew-core repo.
- Updates the [`gh` Homebrew formula](https://github.com/williammartin/homebrew-core/blob/master/Formula/g/gh.rb) in the [`homebrew/homebrew-core` repo](https://github.com/search?q=repo%3AHomebrew%2Fhomebrew-core+%22gh%22+in%3Atitle&type=pullrequests).
To test out the build system while avoiding creating an actual release:
```sh
@ -38,3 +38,12 @@ A local release can be created for testing without creating anything official on
1. Make sure GoReleaser is installed: `brew install goreleaser`
2. `script/release --local`
3. Find the built products under `dist/`.
## Cleaning up a bad release
Occasionally, it might be necessary to clean up a bad release and re-release.
1. Delete the release and associated tag
2. Re-release and monitor the workflow run logs
3. Open pull request updating [`gh` Homebrew formula](https://github.com/williammartin/homebrew-core/blob/master/Formula/g/gh.rb) with new SHA versions, linking the previous PR
4. Verify resulting Debian and RPM packages, Homebrew formula