Skip to content

Commit

Permalink
README: prep for 0.0.4
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <william@trailofbits.com>
  • Loading branch information
woodruffw committed Aug 2, 2022
1 parent 04c5131 commit fd319ac
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- uses: actions/checkout@v3
- name: install
run: python -m pip install .
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
```
Expand Down Expand Up @@ -55,15 +55,15 @@ provided.
To sign one or more files:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file0.txt file1.txt file2.txt
```

The `inputs` argument also supports file globbing:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: ./path/to/inputs/*.txt
```
Expand All @@ -78,7 +78,7 @@ Server during OAuth2.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
oidc-client-id: alternative-sigstore-id
Expand All @@ -94,7 +94,7 @@ Connect Server during OAuth2.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
oidc-client-secret: alternative-sigstore-secret
Expand All @@ -113,7 +113,7 @@ These output files are necessary for verification so turning this setting on wil
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
no-default-files: true
Expand All @@ -129,7 +129,7 @@ when signing multiple input files.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
signature: custom-signature-filename.sig
Expand All @@ -138,7 +138,7 @@ Example:
However, this example is invalid:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file0.txt file1.txt file2.txt
signature: custom-signature-filename.sig
Expand All @@ -154,7 +154,7 @@ work when signing multiple input files.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
certificate: custom-certificate-filename.crt
Expand All @@ -163,7 +163,7 @@ Example:
However, this example is invalid:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file0.txt file1.txt file2.txt
certificate: custom-certificate-filename.crt
Expand All @@ -179,7 +179,7 @@ overwritten.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
overwrite: true
Expand All @@ -195,7 +195,7 @@ from. This setting cannot be used in combination with the `staging` setting.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
fulcio-url: https://fulcio.sigstage.dev
Expand All @@ -211,7 +211,7 @@ cannot be used in combination with the `staging` setting.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
rekor-url: https://rekor.sigstage.dev
Expand All @@ -227,7 +227,7 @@ in combination with the `staging` setting.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
ctfe: ./path/to/ctfe.pub
Expand All @@ -243,7 +243,7 @@ be used in combination with `staging` setting.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
ctfe: ./path/to/rekor.pub
Expand All @@ -260,7 +260,7 @@ checked to ensure that it matches.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
oidc-issuer: https://oauth2.sigstage.dev/auth
Expand All @@ -276,7 +276,7 @@ instead of the default production instances.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
staging: true
Expand All @@ -296,7 +296,7 @@ generated properly and the signature was properly submitted to Rekor.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
verify: false
Expand All @@ -313,7 +313,7 @@ certificate's SAN against the provided value.
This setting only applies if `verify` is set to `true`.

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
verify-cert-email: john.smith@example.com
Expand All @@ -333,7 +333,7 @@ workflow artifact retention period is used.
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
upload-signing-artifacts: true
Expand All @@ -358,7 +358,7 @@ permissions:
# ...
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
release-signing-artifacts: true
Expand All @@ -385,7 +385,7 @@ permissions:
Example:

```yaml
- uses: trailofbits/gh-action-sigstore-python@v0.0.3
- uses: trailofbits/gh-action-sigstore-python@v0.0.4
with:
inputs: file.txt
internal-be-careful-debug: true
Expand Down

0 comments on commit fd319ac

Please sign in to comment.