Skip to content

Commit

Permalink
include additional release process information in dev.md (#354)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhelfand authored Aug 30, 2021
1 parent a9f13d0 commit 5274230
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,39 @@ export KAPPCTRL_E2E_NAMESPACE=kappctrl-test
Release versions are scraped from git tags in the same style as the goreleaser
tool.

Tag the release - it's necessary to do this first because the release process uses the latest tag to record the version.
```
git tag "v1.2.3"
```

Authenticate to the image registry where the image will be pushed (`i.e. index.docker.io/k14s`).

Build and push the kapp-controller image and generate the release YAML.
```
# create and push the release tag (see `git tag --list` for examples)
./hack/build-release.sh
```

The release YAML will be available as `./tmp/release.yml`.

Verify the release deploys successfully to a Kubernetes cluster.
```
kapp deploy -a kc -f ./tmp/release.yml
```

After verifying, push the tag to GitHub.
```
git push --tags
```

After pushing up the tag, you can `Draft a new release` through the GitHub UI and
add release notes in the format shown [here](https://github.com/vmware-tanzu/carvel-kapp-controller/releases/tag/v0.20.0).
Make sure to always thank external contributors for their additions to kapp-controller
in the release notes.

As part of drafting the release through the GitHub UI, include the generated `release.yml`
file and make sure to document the file checksum. This checksum is generated as part of
the `./hack/build-release.sh` but can be rerun as `shasum -a 256 ./tmp/release*.yml`.

### Packaging Development

Due to the fact the one of our resources is named package, which is a golang
Expand Down

0 comments on commit 5274230

Please sign in to comment.