Skip to content

Commit

Permalink
bump version, update changelog (#575)
Browse files Browse the repository at this point in the history
* bump version\, update changelog

* add docs
  • Loading branch information
rbren committed Jun 21, 2021
1 parent 0007b12 commit ccc795d
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<br>
<h3>Best Practices for Kubernetes Workload Configuration</h3>
<a href="https://github.com/FairwindsOps/polaris">
<img src="https://img.shields.io/static/v1.svg?label=Version&message=4.0.2&color=239922">
<img src="https://img.shields.io/static/v1.svg?label=Version&message=4.0.3&color=239922">
</a>
<a href="https://goreportcard.com/report/github.com/FairwindsOps/polaris">
<img src="https://goreportcard.com/badge/github.com/FairwindsOps/polaris">
Expand Down
10 changes: 10 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
---
sidebarDepth: 0
---
## 4.0.3
* Fixed bad interaction between `--set-exit-score-below` and `--only-show-failed-tests`
* Dependency updates
* Support for Helm chart scanning

## 4.0.2
* Goreleaser fix

## 4.0.1
* Goreleaser fix

## 4.0.0
* Add support for arbitrary resources, like Ingress or PodDisruptionBudget
Expand Down
3 changes: 2 additions & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ webhook
--color Whether to use color in pretty format. (default true)
--display-name string An optional identifier for the audit.
-f, --format string Output format for results - json, yaml, pretty, or score. (default "json")
--helm-chart string Will fill out Helm template
--helm-values string Optional flag to add helm values
-h, --help help for audit
--only-show-failed-tests If specified, audit output will only show failed tests.
--output-file string Destination file for audit results.
Expand All @@ -41,7 +43,6 @@ webhook
--set-exit-code-below-score int Set an exit code of 4 when the score is below this threshold (1-100).
--set-exit-code-on-danger Set an exit code of 3 when the audit contains danger-level issues.
# webhook flags
--disable-webhook-config-installer disable the installer in the webhook server, so it won't install webhook configuration resources during bootstrapping.
-h, --help help for webhook
Expand Down
8 changes: 8 additions & 0 deletions docs/infrastructure-as-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ polaris audit --audit-path ./deploy/ \
--only-show-failed-tests true
```

### Audit Helm Charts
You can audit helm charts using the `--helm-chart` and `--helm-values` flags:
```
polaris audit \
--helm-chart ./deploy/chart \
--helm-values ./deploy/chart/values.yml
```

### As Github Action
#### Setup polaris action

Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (

const (
// Version represents the current release version of Polaris
Version = "4.0.2"
Version = "4.0.3"
)

func main() {
Expand Down

0 comments on commit ccc795d

Please sign in to comment.