Skip to content
This repository has been archived by the owner on Oct 30, 2024. It is now read-only.

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dani-santos-code committed Mar 27, 2023
1 parent 3ac358b commit 432df8c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 18 deletions.
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Unreleased
# [Unreleased]
* tba

# 0.22.0
# [0.22.0]

* support for metadata info on sarif result
* Makefile fix for go mod tidy
* test without Kind by default
* 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! 😍
21 changes: 6 additions & 15 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <VERSION> -m "<VERSION>"
Expand All @@ -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=<YOUR 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 it 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.

0 comments on commit 432df8c

Please sign in to comment.