Skip to content

Commit

Permalink
feat: Reference gator verify in gator test --help (#1836)
Browse files Browse the repository at this point in the history
* Reference `gator verify` in `gator test --help`

While we are at liberty to change the `gator` CLI and its subcommands
at will during the "alpha" phase, we have nonetheless created a
confusing situation:

We've replaced `gator test` with a different command, and re-named the
original `gator test` to `gator verify`.

This PR adds some information in the (new) `gator test`'s "help"
message, pointing users to the new command.

Fix #1835

Signed-off-by: juliankatz <juliankatz@google.com>

* Add a note in the website as well

Signed-off-by: juliankatz <juliankatz@google.com>

Co-authored-by: Will Beason <willbeason@google.com>
  • Loading branch information
julianKatz and Will Beason committed Feb 3, 2022
1 parent 542dc4e commit 13c02cb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion cmd/gator/test/test.go
Expand Up @@ -35,7 +35,7 @@ const (

var Cmd = &cobra.Command{
Use: "test",
Short: "test evaluates resources against policies as defined by constraint templates and constraints",
Short: "test evaluates resources against policies as defined by constraint templates and constraints. Note: The alpha `gator test` has been renamed to `gator verify`.",
Example: examples,
Run: run,
}
Expand Down
4 changes: 4 additions & 0 deletions website/docs/gator.md
Expand Up @@ -23,6 +23,10 @@ go get github.com/open-policy-agent/gatekeeper/cmd/gator
Templates and Constraints. The command returns violations when found and
communicates success or failure via its exit status.

Note: The `gator verify` command was first called `gator test`. These names
were changed to better align `gator` with other projects in the
open-policy-agent space.

### Usage

#### Specifying inputs
Expand Down

0 comments on commit 13c02cb

Please sign in to comment.