Skip to content

Commit a9efc8d

Browse files
authored
Merge pull request cli#11801 from cli/eugene/remove_hidden_for_release_verify
visible for `release verify` and `release verify-asset` cmd
2 parents b76bc77 + a203454 commit a9efc8d

2 files changed

Lines changed: 9 additions & 21 deletions

File tree

pkg/cmd/release/verify-asset/verify_asset.go

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,16 @@ func NewCmdVerifyAsset(f *cmdutil.Factory, runF func(*VerifyAssetConfig) error)
4040

4141
cmd := &cobra.Command{
4242
Use: "verify-asset [<tag>] <file-path>",
43-
Short: "Verify that a given asset originated from a specific GitHub Release.",
43+
Short: "Verify that a given asset originated from a release",
4444
Long: heredoc.Doc(`
4545
Verify that a given asset file originated from a specific GitHub Release using cryptographically signed attestations.
4646
47-
## Understanding Verification
48-
4947
An attestation is a claim made by GitHub regarding a release and its assets.
5048
51-
## What This Command Does
52-
53-
This command checks that the asset you provide matches an attestation produced by GitHub for a particular release.
54-
It ensures the asset's integrity by validating:
55-
* The asset's digest matches the subject in the attestation
56-
* The attestation is associated with the specified release
49+
This command checks that the asset you provide matches a valid attestation for the specified release (or the latest release, if no tag is given).
50+
It ensures the asset's integrity by validating that the asset's digest matches the subject in the attestation and that the attestation is associated with the release.
5751
`),
58-
Hidden: true,
59-
Args: cobra.MaximumNArgs(2),
52+
Args: cobra.MaximumNArgs(2),
6053
Example: heredoc.Doc(`
6154
# Verify an asset from the latest release
6255
$ gh release verify-asset ./dist/my-asset.zip

pkg/cmd/release/verify/verify.go

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,16 @@ func NewCmdVerify(f *cmdutil.Factory, runF func(config *VerifyConfig) error) *co
4141
opts := &VerifyOptions{}
4242

4343
cmd := &cobra.Command{
44-
Use: "verify [<tag>]",
45-
Short: "Verify the attestation for a GitHub Release.",
46-
Hidden: true,
47-
Args: cobra.MaximumNArgs(1),
44+
Use: "verify [<tag>]",
45+
Short: "Verify the attestation for a release",
46+
Args: cobra.MaximumNArgs(1),
4847
Long: heredoc.Doc(`
4948
Verify that a GitHub Release is accompanied by a valid cryptographically signed attestation.
5049
51-
## Understanding Verification
52-
5350
An attestation is a claim made by GitHub regarding a release and its assets.
5451
55-
## What This Command Does
56-
57-
This command checks that the specified release (or the latest release, if no tag is given) has a valid attestation.
58-
It fetches the attestation for the release and prints out metadata about all assets referenced in the attestation, including their digests.
52+
This command checks that the specified release (or the latest release, if no tag is given) has a valid attestation.
53+
It fetches the attestation for the release and prints metadata about all assets referenced in the attestation, including their digests.
5954
`),
6055
Example: heredoc.Doc(`
6156
# Verify the latest release

0 commit comments

Comments
 (0)