Add beta designation on attestation command set
With the `gh attestation` command set going into public beta, users should be reminded the feature is in beta and subject to change. Both the short and long help usage are updated for individual command `--help` as well as `gh reference`.
This commit is contained in:
parent
68dfd87f47
commit
0740c00f0a
5 changed files with 24 additions and 11 deletions
|
|
@ -1,6 +1,7 @@
|
|||
package attestation
|
||||
|
||||
import (
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
"github.com/cli/cli/v2/pkg/cmd/attestation/download"
|
||||
"github.com/cli/cli/v2/pkg/cmd/attestation/inspect"
|
||||
"github.com/cli/cli/v2/pkg/cmd/attestation/tufrootverify"
|
||||
|
|
@ -13,9 +14,13 @@ import (
|
|||
func NewCmdAttestation(f *cmdutil.Factory) *cobra.Command {
|
||||
root := &cobra.Command{
|
||||
Use: "attestation [subcommand]",
|
||||
Short: "Work with artifact attestations",
|
||||
Short: "(BETA) Work with artifact attestations",
|
||||
Aliases: []string{"at"},
|
||||
Long: "Download and verify artifact attestations.",
|
||||
Long: heredoc.Doc(`
|
||||
# BETA: Feature subject to change
|
||||
|
||||
Download and verify artifact attestations.
|
||||
`),
|
||||
}
|
||||
|
||||
root.AddCommand(download.NewDownloadCmd(f, nil))
|
||||
|
|
|
|||
|
|
@ -21,8 +21,10 @@ func NewDownloadCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Comman
|
|||
downloadCmd := &cobra.Command{
|
||||
Use: "download [<file-path> | oci://<image-uri>] [--owner | --repo]",
|
||||
Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well as one of --owner or --repo"),
|
||||
Short: "Download an artifact's Sigstore bundle(s) for offline use",
|
||||
Short: "(BETA) Download an artifact's Sigstore bundle(s) for offline use",
|
||||
Long: heredoc.Docf(`
|
||||
# BETA: Feature subject to change
|
||||
|
||||
Download an artifact's attestations, aka Sigstore bundle(s), for offline use.
|
||||
|
||||
The command requires either:
|
||||
|
|
|
|||
|
|
@ -21,10 +21,12 @@ func NewInspectCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command
|
|||
Use: "inspect [<file path> | oci://<OCI image URI>] --bundle <path-to-bundle>",
|
||||
Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well --bundle"),
|
||||
Hidden: true,
|
||||
Short: "Inspect a sigstore bundle",
|
||||
Short: "(BETA) Inspect a sigstore bundle",
|
||||
Long: heredoc.Docf(`
|
||||
# BETA: Feature subject to change
|
||||
|
||||
Inspect a downloaded Sigstore bundle for a given artifact.
|
||||
|
||||
|
||||
The command requires either:
|
||||
* a relative path to a local artifact, or
|
||||
* a container image URI (e.g. %[1]soci://<my-OCI-image-URI>%[1]s)
|
||||
|
|
@ -37,7 +39,7 @@ func NewInspectCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command
|
|||
command).
|
||||
|
||||
By default, the command will print information about the bundle in a table format.
|
||||
If the %[1]s--json-result%[1]s flag is provided, the command will print the
|
||||
If the %[1]s--json-result%[1]s flag is provided, the command will print the
|
||||
information in JSON format.
|
||||
`, "`"),
|
||||
Example: heredoc.Doc(`
|
||||
|
|
|
|||
|
|
@ -21,15 +21,17 @@ func NewTUFRootVerifyCmd(f *cmdutil.Factory, runF func() error) *cobra.Command {
|
|||
var cmd = cobra.Command{
|
||||
Use: "tuf-root-verify --mirror <mirror-url> --root <root.json>",
|
||||
Args: cobra.ExactArgs(0),
|
||||
Short: "Verify the TUF repository from a provided TUF root",
|
||||
Short: "(BETA) Verify the TUF repository from a provided TUF root",
|
||||
Hidden: true,
|
||||
Long: heredoc.Docf(`
|
||||
# BETA: Feature subject to change
|
||||
|
||||
Verify a TUF repository with a local TUF root.
|
||||
|
||||
The command requires you provide the %[1]s--mirror%[1]s flag, which should be the URL
|
||||
The command requires you provide the %[1]s--mirror%[1]s flag, which should be the URL
|
||||
of the TUF repository mirror.
|
||||
|
||||
The command also requires you provide the %[1]s--root%[1]s flag, which should be the
|
||||
|
||||
The command also requires you provide the %[1]s--root%[1]s flag, which should be the
|
||||
path to the TUF root file.
|
||||
|
||||
GitHub relies on TUF to securely deliver the trust root for our signing authority.
|
||||
|
|
|
|||
|
|
@ -23,8 +23,10 @@ func NewVerifyCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command
|
|||
verifyCmd := &cobra.Command{
|
||||
Use: "verify [<file-path> | oci://<image-uri>] [--owner | --repo]",
|
||||
Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well as one of --owner or --repo"),
|
||||
Short: "Verify an artifact's integrity using attestations",
|
||||
Short: "(BETA) Verify an artifact's integrity using attestations",
|
||||
Long: heredoc.Docf(`
|
||||
# BETA: Feature subject to change
|
||||
|
||||
Verify the integrity and provenance of an artifact using its associated
|
||||
cryptographically signed attestations.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue