Skip to content

Commit af45db0

Browse files
author
Paul Savoie
committed
renamed validation to verification
1 parent bf71639 commit af45db0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

actions/submit-signing-request/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,39 @@ The _Github Actions Trusted Build System_ must be enabled in the organization an
2323
| `wait-for-completion` | - | If true, the action will wait for the signing request to complete. Defaults to `true`.
2424
| `output-artifact-directory` | - | Path to where the signed artifact will be extracted. If not specified, the task will not download the signed artifact from SignPath.
2525
| `github-token` | - | GitHub access token used to read job details and download the artifact. Defaults to the [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication). See [Token permissions](#token-permissions) section below.
26-
| `github-extended-verification-token` | - | Separate token for [extended validations](#extended-validation). See [Token permissions](#token-permissions) section below.
26+
| `github-extended-verification-token` | - | Separate token for [extended verification](#extended-verification). See [Token permissions](#token-permissions) section below.
2727
| `wait-for-completion-timeout-in-seconds` | - | Maximum time in seconds that the action will wait for the signing request to complete. Defaults to 10 minutes.
2828
| `service-unavailable-timeout-in-seconds` | - | Total time in seconds that the action will wait for a single service call to succeed (across several retries). Defaults to 10 minutes.
2929
| `download-signed-artifact-timeout-in-seconds` | - | HTTP timeout when downloading the signed artifact. Defaults to 5 minutes.
3030
| `parameters` | - | Multiline-string of values that map to user-defined parameters in the Artifact Configuration. Use one line per parameter with the format `<name>: "<value>"` where `<value>` needs to be a valid JSON string.
3131

3232
See also [action.yml](action.yml)
3333

34-
## Validations
34+
## Verifications
3535

36-
### Basic validation
36+
### Basic verification
3737

3838
SignPath performs a basic set of checks to verify that the signed artifact was built from the expected repository.
3939

40-
### Extended validation
40+
### Extended verification
4141

4242
> [!NOTE]
4343
> This feature is currently only available for selected Enterprise customers. Contact [[email protected]](mailto:[email protected]) if you are interested in using it.
4444
45-
SignPath can perform additional validations to ensure the security of the build pipeline.
45+
SignPath can perform additional verifications to ensure the security of the build pipeline.
4646

47-
The following validations are currently supported:
47+
The following verifications are currently supported:
4848

49-
#### Runner validations
49+
#### Runner verifications
5050

5151
Restricts all workflow jobs leading to the signed artifact to run on runners from a defined set of runner groups.
5252

53-
#### Branch ruleset validations
53+
#### Branch ruleset verifications
5454

5555
Ensures that certain branch rules are enforced on GitHub.
5656

5757
* Bypassers of the ruleset can be restricted.
58-
* Continous enforcement of the rules from a specified date can be validated. _Note: Full functionality only available for GitHub Enterprise subscriptions._
58+
* Continous enforcement of the rules from a specified date can be verified. _Note: Full functionality only available for GitHub Enterprise subscriptions._
5959

6060
The following [branch ruleset rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets) are currently supported:
6161

@@ -71,7 +71,7 @@ The following [branch ruleset rules](https://docs.github.com/en/repositories/con
7171

7272
#### `github-token`
7373

74-
The `github-token` is used for [basic validation](#basic-validation) and for downloading the artifact to SignPath.io. This token will be stored (encrypted) on SignPath.io, and should be short-lived with minimal permissions. It is recommended to use the default `secrets.GITHUB_TOKEN`.
74+
The `github-token` is used for [basic verification](#basic-verification) and for downloading the artifact to SignPath.io. This token will be stored (encrypted) on SignPath.io, and should be short-lived with minimal permissions. It is recommended to use the default `secrets.GITHUB_TOKEN`.
7575

7676
The permissions of the `secrets.GITHUB_TOKEN` are set to `permissive` (default) or `restricted` in the repository, organization or enterprise. See the [GitHub documentation](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) for more details. In the latter case, the `action.read` and `content:read` permissions need to be explicitly set in the workflow definition for the respective job using the following snippet:
7777

@@ -85,7 +85,7 @@ jobs:
8585
8686
#### `github-extended-verification-token`
8787

88-
The `github-extended-verification-token` is used if the `github-token` does not have sufficient permissions for performing [extended validations](#extended-validation). This token is only used temporarily and will not be stored on SignPath.io.
88+
The `github-extended-verification-token` is used if the `github-token` does not have sufficient permissions for performing [extended verifications](#extended-verification). This token is only used temporarily and will not be stored on SignPath.io.
8989

9090
It requires the _Repository metadata read_ permission and, for GitHub Enterprise subscriptions that check the validity of those rules in the past, the _Get the audit log for an enterprise_ permission.
9191

0 commit comments

Comments
 (0)