b3af55cffa
* expected behaviour docs of the command sub-version partially addresses #3088 Signed-off-by: Omri Bornstein <omribor@gmail.com> * initial version stdout testing Signed-off-by: Omri Bornstein <omribor@gmail.com> * more verbose version stdout test Signed-off-by: Omri Bornstein <omribor@gmail.com> * resolves comments of PR 3447 Signed-off-by: Omri Bornstein <omribor@gmail.com> * moved version docs to root level md file Signed-off-by: Omri Bornstein <omribor@gmail.com> * added missing new line in CLI.md Signed-off-by: Omri Bornstein <omribor@gmail.com> * golangci linting fix Signed-off-by: Omri Bornstein <omribor@gmail.com> --------- Signed-off-by: Omri Bornstein <omribor@gmail.com>
1.9 KiB
1.9 KiB
Cosign CLI Conventions
- The primary output of any command should be to STDOUT. The format should be described in the documentation of each command.
- Output to STDERR is informational only.
Expected cosign version Behaviour
From version 2.1.0 (as part of a dependency update), the version metadata is printed to standard output. By default it includes the package version, commit hash, git tree state, build date, Go version, compiler toolchain and current platform.
ASCII Output
The output of cosign version is expected to resemble this format, with the specific values being appropriate for each build of the cosign package.
$ cosign version
______ ______ _______. __ _______ .__ __.
/ | / __ \ / || | / _____|| \ | |
| ,----'| | | | | (----`| | | | __ | \| |
| | | | | | \ \ | | | | |_ | | . ` |
| `----.| `--' | .----) | | | | |__| | | |\ |
\______| \______/ |_______/ |__| \______| |__| \__|
cosign: A tool for Container Signing, Verification and Storage in an OCI registry.
GitVersion: [vX.Y.Z or devel]
GitCommit: [hash or unknown]
GitTreeState: [clean or dirty]
BuildDate: [yyyy-MM-ddThh:mm:ss or unknown]
GoVersion: go1.A.B
Compiler: gc
Platform: os/arch
JSON Output
The output of cosign version --json is expected to resemble this format, with the specific values being appropriate for each build of the cosign package.
$ cosign version --json
{
"gitVersion": "[vX.Y.Z or devel]",
"gitCommit": "[hash or unknown]",
"gitTreeState": "[clean or dirty]",
"buildDate": "[yyyy-MM-ddThh:mm:ss or unknown]",
"goVersion": "go1.A.B",
"compiler": "gc",
"platform": "os/arch"
}