Skip to content

Commit

Permalink
docs: Add Documentation for --yes Flag in Blob Signing (#274)
Browse files Browse the repository at this point in the history 
* Add yes flag desc

Signed-off-by: mrlutik <yaievgeniy@gmail.com>

* Fix typo in shell command

Signed-off-by: mrlutik <yaievgeniy@gmail.com>

* Add backticks to the flag representation in description

Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com>
Signed-off-by: Eugene <70693118+MrLutik@users.noreply.github.com>

---------

Signed-off-by: mrlutik <yaievgeniy@gmail.com>
Signed-off-by: Eugene <70693118+MrLutik@users.noreply.github.com>
Co-authored-by: ltagliaferri <lisa.tagliaferri@gmail.com>
  • Loading branch information
@MrLutik @ltagliaferri
MrLutik and ltagliaferri authored Nov 22, 2023
1 parent e67edae commit a107eef
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions content/en/signing/signing_with_blobs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,10 @@ You can sign it with the normal `cosign sign` command and flags:
```shell
$ cosign sign gcr.io/user/demo/artifact

Check failure on line 97 in content/en/signing/signing_with_blobs.md

View workflow job for this annotation

GitHub Actions / markdownlint

Dollar signs used before commands without showing output 

content/en/signing/signing_with_blobs.md:97:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ cosign sign gcr.io/user/demo..."] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md014.md
```

Check failure on line 98 in content/en/signing/signing_with_blobs.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should be surrounded by blank lines 

content/en/signing/signing_with_blobs.md:98 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md031.md
## Non-Interactive Signing with the Yes Flag

Check failure on line 99 in content/en/signing/signing_with_blobs.md

View workflow job for this annotation

GitHub Actions / markdownlint

Headings should be surrounded by blank lines 

content/en/signing/signing_with_blobs.md:99 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## Non-Interactive Signing with the Yes Flag"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md022.md

In situations where automated signing is required, such as within CI/CD pipelines, the `--yes` flag becomes essential. This flag, when used with signing commands, bypasses any confirmation prompts, enabling a smooth, uninterrupted signing process. This is particularly crucial in automated environments where manual input isn't feasible. The `--yes` flag ensures that your signing operations can proceed without manual intervention, maintaining the efficiency and speed of your automated workflows.

```

Check failure on line 103 in content/en/signing/signing_with_blobs.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified 

content/en/signing/signing_with_blobs.md:103 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
cosign sign-blob --yes -key cosign.key myregistry/myimage:latest
```

Check failure on line 105 in content/en/signing/signing_with_blobs.md

View workflow job for this annotation

GitHub Actions / markdownlint

Files should end with a single newline character 

content/en/signing/signing_with_blobs.md:105:3 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md047.md

0 comments on commit a107eef

Please sign in to comment.