From 569825790bbf4b9dc5fc40abcd2f03e7cee4a2c2 Mon Sep 17 00:00:00 2001 From: Daniele Santos Date: Mon, 27 Mar 2023 09:54:37 -0400 Subject: [PATCH] update docs --- CHANGELOG.md | 6 +++--- docs/release.md | 21 ++++++--------------- 2 files changed, 9 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f0d57fe..d60cf7ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ -# Unreleased +# [Unreleased] * tba -# 0.22.0 +# [0.22.0] * support for metadata info on sarif result * Makefile fix for go mod tidy @@ -9,7 +9,7 @@ * deprecate kubernetes.io in override labels -# 0.21.0 +# [0.21.0] * the Seccomp auditor has been updated to flag missing Seccomp profiles in securityContext instead of deprecated seccomp annotations. Thank you @Ser87ch, for your amazing contribution! 👏 * Override added for the unconfined apparmor profile! Once again, thank you @Ser87ch! 😍 diff --git a/docs/release.md b/docs/release.md index 6bdb0605..c5aff267 100644 --- a/docs/release.md +++ b/docs/release.md @@ -10,7 +10,9 @@ If the changes since the most recent release are bug fixes only, bump the last n 3. Update the `VERSION` file if necessary. You'll have to open / merge a PR to do this. -4. Create a tag with the new version and push it up to Github: +4. update `CHANGELOG.md` with a summary of what has changed. Add a new version header at the top of the document, just after `Unreleased` + +5. Create a tag with the new version and push it up to Github: ``` git tag -a -m "" @@ -24,26 +26,15 @@ git tag -a v0.11.6 -m "v0.11.6" git push origin v0.11.6 ``` -5. You will need a Github token in order for Goreleaser to be able to create a release in Github. If you already have one, skip to the next step. - -[Create a Github token](https://github.com/settings/tokens/new) with the `repo` scope. - -6. Run Goreleaser - -``` -GITHUB_TOKEN= goreleaser --rm-dist -``` - -7. Publish the release in Github -Goreleaser is set to draft mode which means it will create a draft release in Github, allowing you to double check the release and make changes to the Changelog. Find the [draft release](https://github.com/Shopify/kubeaudit/releases) and make sure there are no commits to main since the release. +6. Once you push the tag, the release Github action will be triggered and generate a draft release in Github, allowing you to double check the release and make changes to the Changelog. Find the [draft release](https://github.com/Shopify/kubeaudit/releases) and make sure there are no commits to main since the release. > If there are commits to main since the release, this may mean you didn't make the tag on main or your main is out of date. -Click `Edit` on the right of the draft release and tidy up the Changelog if necessary. We like to add thank you's to external contributors, for example: +7. Click `Edit` on the right of the draft release and tidy up the Changelog if necessary. We like to add thank you's to external contributors, for example: ``` 202e355 Fixed code quality issues using DeepSource (#315) - Thank you @withshubh for the contribution! ``` -Click on `Publish release` at the bottom. +8. Click on `Publish release` at the bottom.