Skip to content

Commit

Permalink
add release process
Browse files Browse the repository at this point in the history
  • Loading branch information
wagoodman committed Jul 7, 2023
1 parent 8003980 commit 559e5e2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ sudo apt install ./dive_${DIVE_VERSION}_linux_amd64.deb
```bash
export DIVE_VERSION=$(curl -sL "https://api.github.com/repos/wagoodman/dive/releases/latest" | grep '"tag_name":' | sed -E 's/.*"v([^"]+)".*/\1/')
curl -OL https://github.com/wagoodman/dive/releases/download/v${DIVE_VERSION}/dive_${DIVE_VERSION}_linux_amd64.rpm
rpm -i dive_0.9.2_linux_amd64.rpm
rpm -i dive_${DIVE_VERSION}_linux_amd64.rpm
```

**Arch Linux**
Expand Down
24 changes: 24 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Release process


## Creating a release

**Trigger a new release with `make release`**.

At this point you'll see a preview changelog in the terminal. If you're happy with the
changelog, press `y` to continue, otherwise you can abort and adjust the labels on the
PRs and issues to be included in the release and re-run the release trigger command.


## Retracting a release

If a release is found to be problematic, it can be retracted with the following steps:

- Deleting the GitHub Release
- Untag the docker images in the `docker.io` registry
- Revert the brew formula in [`wagoodman/homebrew-dive`](https://github.com/wagoodman/homebrew-dive) to point to the previous release
- Add a new `retract` entry in the go.mod for the versioned release

**Note**: do not delete release tags from the git repository since there may already be references to the release
in the go proxy, which will cause confusion when trying to reuse the tag later (the H1 hash will not match and there
will be a warning when users try to pull the new release).

0 comments on commit 559e5e2

Please sign in to comment.