Skip to content

Commit

Permalink
Prep release (#39)
Browse files Browse the repository at this point in the history
* requirements: sigstore 0.9.0

Signed-off-by: William Woodruff <william@trailofbits.com>

* README: prep new version

Signed-off-by: William Woodruff <william@trailofbits.com>

Signed-off-by: William Woodruff <william@trailofbits.com>
  • Loading branch information
woodruffw committed Dec 22, 2022
1 parent b290ffb commit d161077
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
42 changes: 21 additions & 21 deletions README.md
Expand Up @@ -27,7 +27,7 @@ jobs:
- uses: actions/checkout@v3
- name: install
run: python -m pip install .
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
```
Expand Down Expand Up @@ -55,15 +55,15 @@ provided.
To sign one or more files:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file0.txt file1.txt file2.txt
```

The `inputs` argument also supports file globbing:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: ./path/to/inputs/*.txt
```
Expand All @@ -76,7 +76,7 @@ The `identity-token` setting controls the OpenID Connect token provided to Fulci
workflow will use the credentials found in the GitHub Actions environment.

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
identity-token: ${{ IDENTITY_TOKEN }} # assigned elsewhere
Expand All @@ -92,7 +92,7 @@ Server during OAuth2.
Example:

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

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
oidc-client-secret: alternative-sigstore-secret
Expand All @@ -124,7 +124,7 @@ when signing multiple input files.
Example:

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

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

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

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file0.txt file1.txt file2.txt
certificate: custom-certificate-filename.crt
Expand All @@ -174,7 +174,7 @@ from. This setting cannot be used in combination with the `staging` setting.
Example:

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

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

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

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
ctfe: ./path/to/rekor.pub
Expand All @@ -238,7 +238,7 @@ instead of the default production instances.
Example:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
staging: true
Expand All @@ -261,7 +261,7 @@ and `verify-oidc-issuer` settings. Failing to pass these will produce an error.
Example:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
verify: true
Expand All @@ -284,7 +284,7 @@ This setting may only be used in conjunction with `verify-oidc-issuer`.
Supplying it without `verify-oidc-issuer` will produce an error.

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
verify: true
Expand All @@ -309,7 +309,7 @@ Supplying it without `verify-cert-identity` will produce an error.
Example:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
verify: true
Expand All @@ -331,7 +331,7 @@ workflow artifact retention period is used.
Example:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
upload-signing-artifacts: true
Expand All @@ -356,7 +356,7 @@ permissions:

# ...

- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
release-signing-artifacts: true
Expand All @@ -383,7 +383,7 @@ permissions:
Example:

```yaml
- uses: sigstore/gh-action-sigstore-python@v0.0.11
- uses: sigstore/gh-action-sigstore-python@v0.2.0
with:
inputs: file.txt
internal-be-careful-debug: true
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
@@ -1 +1 @@
sigstore==0.8.3
sigstore==0.9.0

0 comments on commit d161077

Please sign in to comment.