Skip to content

Commit

Permalink
docs(*) add 1.8.3 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis Raines committed Dec 1, 2021
1 parent 4820ab9 commit 8cfe7b7
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Table of Contents

- [v1.8.3](#v183)
- [v1.8.2](#v182)
- [v1.8.1](#v181)
- [v1.8.0](#v180)
Expand Down Expand Up @@ -33,6 +34,19 @@
- [v0.2.0](#v020)
- [v0.1.0](#v010)

## [v1.8.3]

> Release date: 2021/12/02
### Fixed

- `--select-tag` applies its tags to newly-created entities whether or not the
tag is also present in the state file metadata.
[#517](https://github.com/Kong/deck/pull/517)
- Timeouts in `Syncer.Run()` now return an error. Downstream clients using decK
as a library can determine when their sync attempt failed due to a timeout.
[#529](https://github.com/Kong/deck/pull/529)

## [v1.8.2]

> Release date: 2021/09/27
Expand Down
54 changes: 54 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
eleasing a version

## Prepare

Ensure that your `go version` is at least 1.15.x.
Create a `docs/changelog-v0.5.0` branch. Substitute v0.5.0 with the version
you are releasing.
Write the changelog, ensure the links are all created correctly and
make sure to write the doc with end-user in mind.
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.
Once the changelog looks good, open a PR against the main branchpush the commit to main branch. And merge the PR.
Ensure you have Goreleaser and Docker installed locally.

## Release

- Tag the `HEAD` with your version. In our example, we will tag it `v0.5.0`.
- Push the tag to remote (Github).

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

- Run Goreleaser: `goreleaser release --rm-dist`. This will create
a release in Github and upload all the artifacts.
- 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
Clone the Kong/homebrew-deck repo
`cp <deck repo>/dist/deck.rb Formula/`. Make sure only version and checksum is changed and rest all is left as is.
Git commit, git push to master

## Docker release

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

Assuming you are on the TAG commit, you need to perform the following:

```
export TAG=$(git describe --abbrev=0 --tags)
export COMMIT=$(git rev-parse --short $TAG)
docker build --build-arg TAG=$TAG --build-arg COMMIT=$COMMIT -t hbagdi/deck:$TAG .
docker push hbagdi/deck:$TAG
docker tag hbagdi/deck:$TAG kong/deck:$TAG
docker push kong/deck:$TAG
# if also the latest release (not for a back-ported patch release):
docker tag hbagdi/deck:$TAG hbagdi/deck:latest
docker push hbagdi/deck:latest
docker tag hbagdi/deck:latest kong/deck:latest
docker push kong/deck:latest
```

0 comments on commit 8cfe7b7

Please sign in to comment.