Skip to content

Commit 8d9ee14

Browse files
authored
docs(zizmor): drop default-config (#966)
We removed this in 58cb396 but didn't get rid of the entry in `.github/workflows/reusable-zizmor.md`. Do that and explain the behaviour in the description of `always-use-default-config`.
1 parent 8ce69f8 commit 8d9ee14

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

.github/workflows/reusable-zizmor.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,16 +90,17 @@ jobs:
9090
9191
## Inputs
9292
93-
| Name | Type | Description | Default Value | Required |
94-
| ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------- |
95-
| min-severity | string | Only show results at or above this severity [possible values: unknown, informational, low, medium, high] | medium | false |
96-
| min-confidence | string | Only show results at or above this confidence level [possible values: unknown, low, medium, high] | low | false |
97-
| fail-severity | string | Fail the build if any result is at or above this severity [possible values: never, any, informational, low, medium, high] | high | false |
98-
| runs-on | string | The runner to use for jobs. Configure this to use self-hosted runners. | ubuntu-latest | false |
99-
| default-config | boolean | The default Zizmor configuration to use. If `always-use-default-config` is `true`, this configuration will always be used. Otherwise, it will be used if the repository does not have a `.github/zizmor.yml` or `zizmor.yml` file. | true | false |
100-
| always-use-default-config | boolean | Whether to always use `default-config`. | false | false |
101-
| github-token | string | Use a different token to the default | ${github.token} | false |
102-
| extra-args | string | Extra arguments to pass into zizmor | "" | false |
93+
| Name | Type | Description | Default Value | Required |
94+
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------- |
95+
| min-severity | string | Only show results at or above this severity [possible values: unknown, informational, low, medium, high] | medium | false |
96+
| min-confidence | string | Only show results at or above this confidence level [possible values: unknown, low, medium, high] | low | false |
97+
| fail-severity | string | Fail the build if any result is at or above this severity [possible values: never, any, informational, low, medium, high] | high | false |
98+
| runs-on | string | The runner to use for jobs. Configure this to use self-hosted runners. | ubuntu-latest | false |
99+
| always-use-default-config | boolean | Whether to always use the [default configuration]. When `false`, `.zizmor.yml` or `.github/zizmor.yml` will be used, if present. | false | false |
100+
| github-token | string | The GitHub token to use when authenticating with the GitHub API | ${github.token} | false |
101+
| extra-args | string | Extra arguments to pass into zizmor | "" | false |
102+
103+
[default configuration]: ../zizmor.yml
103104

104105
## Getting started
105106

.github/workflows/reusable-zizmor.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ on:
3434
default: ${{ github.token }}
3535

3636
always-use-default-config:
37-
description: Whether to always use the default configuration.
37+
description: |
38+
Whether to always use the default configuration. When `false`,
39+
`.zizmor.yml` or `.github/zizmor.yml` will be used, if present.
3840
required: false
3941
type: boolean
4042
default: false

0 commit comments

Comments
 (0)