Skip to content

Commit 6012e00

Browse files
elasticdogelasticdog
committed
Document reusable workflow inputs
1 parent 015782f commit 6012e00

3 files changed

Lines changed: 94 additions & 39 deletions

File tree

‎docs/common.md‎

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,27 @@ jobs:
6868
Lints GitHub Actions workflow files using
6969
[actionlint](https://github.com/rhysd/actionlint).
7070

71+
**Inputs**
72+
73+
| Name | Required | Default |
74+
| ---------------- | -------- | --------- |
75+
| `zizmor_persona` | false | `regular` |
76+
77+
`zizmor_persona` must be `regular`, `pedantic`, or `auditor`.
78+
7179
---
7280

7381
## check-markdown.yml
7482

7583
Checks Markdown formatting using [Prettier](https://prettier.io/).
7684

85+
**Inputs**
86+
87+
| Name | Required | Default |
88+
| ------------------ | -------- | --------- |
89+
| `files` | false | `**/*.md` |
90+
| `prettier_version` | false | `latest` |
91+
7792
---
7893

7994
## check-shell.yml
@@ -88,6 +103,12 @@ Formats and lints shell scripts using
88103
Detects common misspellings across files using
89104
[typos](https://github.com/crate-ci/typos).
90105

106+
**Inputs**
107+
108+
| Name | Required | Default |
109+
| ------- | -------- | ------- |
110+
| `files` | false | `.` |
111+
91112
---
92113

93114
## check-stylelint.yml
@@ -98,10 +119,10 @@ the latest published stylelint package through `npx`; callers can pin
98119

99120
**Inputs**
100121

101-
| Name | Default |
102-
| ------------------- | ---------- |
103-
| `files` | `**/*.css` |
104-
| `stylelint_version` | `latest` |
122+
| Name | Required | Default |
123+
| ------------------- | -------- | ---------- |
124+
| `files` | false | `**/*.css` |
125+
| `stylelint_version` | false | `latest` |
105126

106127
**Typical usage with changed files**
107128

@@ -157,9 +178,9 @@ branch protection rules.
157178

158179
**Inputs**
159180

160-
| Name | Required |
161-
| --------------- | -------- |
162-
| `needs_context` | true |
181+
| Name | Required | Default |
182+
| --------------- | -------- | ------- |
183+
| `needs_context` | true | — |
163184

164185
`needs_context` should be set to `${{ toJson(needs) }}`.
165186

@@ -210,9 +231,9 @@ Create and push a missing SemVer tag (via
210231

211232
**Inputs**
212233

213-
| Name | Required |
214-
| ------------------- | -------- |
215-
| `toolbox_envy_bins` | true |
234+
| Name | Required | Default |
235+
| ------------------- | -------- | ------- |
236+
| `toolbox_envy_bins` | true | — |
216237

217238
The `toolbox_envy_bins` entries must exist as `bin/<name>` in Toolbox Envy and
218239
may be newline- or comma-separated; invalid names will fail the job.

‎docs/flutter.md‎

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ preparation pull request.
5858

5959
**Inputs**
6060

61-
| Name | Required |
62-
| ------------- | -------- |
63-
| date_override | false |
64-
| format | false |
61+
| Name | Required | Default |
62+
| --------------- | -------- | ------- |
63+
| `date_override` | false | `""` |
64+
| `format` | false | `""` |
6565

6666
**Secrets**
6767

@@ -83,9 +83,9 @@ preparation pull request.
8383

8484
**Inputs**
8585

86-
| Name | Required |
87-
| ----- | -------- |
88-
| level | true |
86+
| Name | Required | Default |
87+
| ------- | -------- | ------- |
88+
| `level` | true | — |
8989

9090
**Secrets**
9191

@@ -105,19 +105,33 @@ and uploads them to the release.
105105

106106
**Inputs**
107107

108-
| Name | Required | Default |
109-
| ----------------------------- | -------- | ---------- |
110-
| slug | true | — |
111-
| build_android_aab | false | true |
112-
| build_ios_ipa | false | true |
113-
| android_app_signing_key_alias | false | appsigning |
114-
| android_upload_key_alias | false | upload |
108+
| Name | Required | Default |
109+
| ------------------------------- | -------- | ------------ |
110+
| `slug` | true | — |
111+
| `build_android_aab` | false | `true` |
112+
| `build_ios_ipa` | false | `true` |
113+
| `android_app_signing_key_alias` | false | `appsigning` |
114+
| `android_upload_key_alias` | false | `upload` |
115+
116+
**Secrets**
117+
118+
| Name | Required |
119+
| --------------------------------------- | -------- |
120+
| `ANDROID_APP_SIGNING_KEYSTORE_B64` | true |
121+
| `ANDROID_APP_SIGNING_KEYSTORE_PASSWORD` | true |
122+
| `ANDROID_APP_SIGNING_KEY_PASSWORD` | true |
123+
| `ANDROID_UPLOAD_KEYSTORE_B64` | false |
124+
| `ANDROID_UPLOAD_KEYSTORE_PASSWORD` | false |
125+
| `ANDROID_UPLOAD_KEY_PASSWORD` | false |
126+
| `IOS_SIGNING_CERT_B64` | false |
127+
| `IOS_SIGNING_CERT_PASSWORD` | false |
128+
| `IOS_PROVISIONING_PROFILE_B64` | false |
115129

116130
**Environment Configuration**
117131

118-
This workflow reads signing material from the `signing` environment in the
119-
calling repository. Callers do not need to pass signing secrets through
120-
`workflow_call`.
132+
This workflow runs build jobs in the `signing` environment and reads signing
133+
material through the `secrets` context. Optional workflow-call secrets are still
134+
validated at runtime when the corresponding artifact type is enabled.
121135

122136
**Required in `signing` environment (always)**
123137

@@ -155,11 +169,11 @@ Workload Identity Federation (WIF).
155169

156170
**Inputs**
157171

158-
| Name | Required | Default |
159-
| -------------- | -------- | -------- |
160-
| release_tag | true | — |
161-
| track | false | internal |
162-
| release_status | false | draft |
172+
| Name | Required | Default |
173+
| ---------------- | -------- | ---------- |
174+
| `release_tag` | true | — |
175+
| `track` | false | `internal` |
176+
| `release_status` | false | `draft` |
163177

164178
**Environment Configuration**
165179

@@ -185,9 +199,15 @@ authentication.
185199

186200
**Inputs**
187201

188-
| Name | Required | Default |
189-
| ----------- | -------- | ------- |
190-
| release_tag | true | — |
202+
| Name | Required | Default |
203+
| ------------- | -------- | ------- |
204+
| `release_tag` | true | — |
205+
206+
**Secrets**
207+
208+
| Name | Required |
209+
| ------------------ | -------- |
210+
| `ASC_AUTH_KEY_B64` | false |
191211

192212
**Environment Configuration**
193213

‎docs/rust.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,12 @@ versions, update documentation, and open a PR.
6161
6262
**Inputs**
6363
64-
- package
65-
- level
64+
| Name | Required | Default |
65+
| --------- | -------- | ------- |
66+
| `package` | true | — |
67+
| `level` | true | — |
68+
69+
`level` must be `major`, `minor`, `patch`, `release`, `rc`, `beta`, or `alpha`.
6670

6771
**Secrets**
6872

@@ -94,16 +98,26 @@ This workflow requires a GitHub App token (see namespace note above).
9498

9599
Publishes an unpublished Rust crate to crates.io.
96100

97-
**Required secret**
101+
**Required permissions**
102+
103+
- `id-token: write`
98104

99-
- `CARGO_REGISTRY_TOKEN`
105+
This workflow uses trusted publishing through
106+
[`rust-lang/crates-io-auth-action`](https://github.com/rust-lang/crates-io-auth-action)
107+
instead of a `CARGO_REGISTRY_TOKEN` secret.
100108

101109
---
102110

103111
## draft-release-rust.yml
104112

105113
Creates a GitHub draft release and uploads compiled artifacts across platforms.
106114

115+
**Inputs**
116+
117+
| Name | Required | Default |
118+
| --------- | -------- | ------- |
119+
| `package` | true | — |
120+
107121
---
108122

109123
## deploy-github-pages-rust.yml

0 commit comments

Comments
 (0)