Skip to content

Commit

Permalink
fix(docs): update install and release instructions (#1257)
Browse files Browse the repository at this point in the history
fixes #1255
  • Loading branch information
Tieske committed Mar 27, 2024
1 parent 3632a2e commit f13a65e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ the GitHub [release page](https://github.com/kong/deck/releases)
or install by downloading the binary:

```shell
$ curl -sL https://github.com/kong/deck/releases/download/v1.8.1/deck_1.8.1_linux_amd64.tar.gz -o deck.tar.gz
$ curl -sL https://github.com/kong/deck/releases/download/v1.36.1/deck_1.36.1_linux_amd64.tar.gz -o deck.tar.gz
$ tar -xf deck.tar.gz -C /tmp
$ sudo cp /tmp/deck /usr/local/bin/
```
Expand All @@ -84,7 +84,7 @@ If you are on Windows, you can download the binary from the GitHub
[release page](https://github.com/kong/deck/releases) or via PowerShell:

```shell
$ curl -sL https://github.com/kong/deck/releases/download/v1.8.1/deck_1.8.1_windows_amd64.tar.gz -o deck.tar.gz
$ curl -sL https://github.com/kong/deck/releases/download/v1.36.1/deck_1.36.1_windows_amd64.tar.gz -o deck.tar.gz
$ tar -xzvf deck.tar.gz
```

Expand Down
21 changes: 11 additions & 10 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,29 @@
## Prepare

1. Create a `docs/changelog-v0.5.0` branch. Substitute v0.5.0 with the version you are releasing.
2. Add an entry to CHANGELOG.md for your version, with entries for merged PRs since the previous release. Make sure to write the doc with end-user in mind.
3. Add a ToC entry at the top of CHANGELOG.md (e.g. `- [v0.5.0](#v050)`) and a compare link at the bottom of CHANGELOG.md (e.g. `[v0.5.0]: https://github.com/hbagdi/deck/compare/v0.4.0...v0.5.0`).
4. Commit and push the branch to Github. Ensure that the Markdown is rendered correctly. Make changes as needed. The link on the version itself won't resolve correctly as the tag is not yet created.
5. Open a PR against the main branch and merge the PR.
1. In `README.md` update the installation instruction (Linux and Windows) to have the new version in the `curl` command.
1. Add an entry to CHANGELOG.md for your version, with entries for merged PRs since the previous release. Make sure to write the doc with end-user in mind.
1. Add a ToC entry at the top of CHANGELOG.md (e.g. `- [v0.5.0](#v050)`) and a compare link at the bottom of CHANGELOG.md (e.g. `[v0.5.0]: https://github.com/hbagdi/deck/compare/v0.4.0...v0.5.0`).
1. Commit and push the branch to Github. Ensure that the Markdown is rendered correctly. Make changes as needed. The link on the version itself won't resolve correctly as the tag is not yet created.
1. Open a PR against the main branch and merge the PR.

## Release

1. Pull `main` and tag `HEAD` with your version. In our example, we will tag it `v0.5.0`: `git tag v0.5.0`
2. Push the tag to remote (Github): `git push origin --tags`
1. Push the tag to remote (Github): `git push origin --tags`

As of 1.9.0, the remaining steps are automated on tag pushes to Github. They are unnecessary unless the release job fails.

1. Ensure that your `go version` is not older than indicated in the header of `go.mod` and that you have goreleaser installed.
2. Run Goreleaser: `goreleaser release --rm-dist`. This will create a release in Github and upload all the artifacts.
3. Edit the release to remove all the commit messages as the content and instead add a link to the changelog. Refer to older releases for reference.
1. Run Goreleaser: `goreleaser release --rm-dist`. This will create a release in Github and upload all the artifacts.
1. Edit the release to remove all the commit messages as the content and instead add a link to the changelog. Refer to older releases for reference.

## Homebrew release

1. Clone the [Kong/homebrew-deck](https://github.com/Kong/homebrew-deck) repo.
2. Download and unpack `dist.zip` from the [release job artifacts](https://github.com/Kong/deck/actions/workflows/release.yaml).
3. `cp <unpack directory>/deck.rb <homebrew-deck directory>/Formula/`. Make sure only version and checksum is changed and rest all is left as is.
4. Commit and push to master.
1. Download and unpack `dist.zip` from the [release job artifacts](https://github.com/Kong/deck/actions/workflows/release.yaml).
1. `cp <unpack directory>/deck.rb <homebrew-deck directory>/Formula/`. Make sure only version and checksum is changed and rest all is left as is.
1. Commit and push to master.

## Docker release

Expand Down

0 comments on commit f13a65e

Please sign in to comment.