Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

action: flip release-signing-artifacts #142

Merged
merged 1 commit into from
Jul 8, 2024
Merged

action: flip release-signing-artifacts #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ Example:

### `release-signing-artifacts`

**Default**: `false`
**Default**: `true`

The `release-signing-artifacts` setting controls whether or not `sigstore-python`
uploads signing artifacts to the release publishing event that triggered this run.
Expand All @@ -323,8 +323,6 @@ This setting has no effect on non-`release` events.
If enabled, this setting also re-uploads and signs GitHub's default source code artifacts,
as they are not guaranteed to be stable.

By default, no release assets are uploaded.

Requires the [`contents: write` permission](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token).

Example:
Expand All @@ -342,19 +340,16 @@ permissions:
```

On release events, it is also valid to have no explicit inputs. When used on release
events with `release-signing-artifacts: true`, this action will sign any pre-existing
release artifacts:
events, this action will sign any pre-existing release artifacts:

```yaml
permissions:
contents: write
# ...
# no explicit settings needed, signs all pre-existing release artifacts
- uses: sigstore/gh-action-sigstore-python@v2.1.1
with:
# Only valid on release events
release-signing-artifacts: true
```

### Internal options
Expand Down
10 changes: 5 additions & 5 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ inputs:
staging:
description: "use sigstore's staging instances, instead of the default production instances"
required: false
default: false
default: "false"
verify:
description: "verify the generated signatures after signing"
required: false
default: false
default: "false"
verify-cert-identity:
description: |
verify the identity in the signing certificate's Subject Alternative Name
Expand All @@ -69,15 +69,15 @@ inputs:
upload-signing-artifacts:
description: "upload all signing artifacts as workflow artifacts"
required: false
default: false
default: "false"
release-signing-artifacts:
description: "attach all signing artifacts as release assets"
required: false
default: false
default: "true"
internal-be-careful-debug:
description: "run with debug logs (default false)"
required: false
default: false
default: "false"

runs:
using: "composite"
Expand Down
Loading