From 0e191ef0f2f9e857d5f1ff6c4b626aa35a19ad01 Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Fri, 20 Dec 2024 15:34:26 -0500 Subject: [PATCH] Update releasing.md --- docs/releasing.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/releasing.md b/docs/releasing.md index d9b01ea41..4b977efdd 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -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