You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/reference/process-workflow-fleet-standard.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,7 @@ decisions before canonical guides, templates, or consumer workflows adopt it:
148
148
| Permissions | Default deny at workflow level, then grant the caller job `contents: read`, `pages: write`, and `id-token: write`. | Selected for the candidate: use `GITHUB_TOKEN` for repository-local, non-user-facing platform operations and App tokens for user-facing or otherwise unsupported operations. |
149
149
| Fork behavior | Keep the caller unconditional; classify fork pull requests as restricted read-only validation in `Plan`. | Selected for the candidate; execution policy belongs to Process-PSModule rather than every consumer. |
150
150
| Credentials | Explicitly map the three v8 credentials; optionally map `TestData` when module-local tests need it. | Define a narrower credential profile for repositories that cannot publish. |
151
-
| Optional surface | Permit only documented `TestData`, workflow inputs, schedule timing, and presentation metadata. | Allow additional extension points after naming and compatibility rules are agreed. |
151
+
| Optional surface | Permit only the documented `TestData` secret mapping. | Selected for the candidate; every other caller-contract field matches the canonical template. |
152
152
153
153
The `v8` reference is the controlled moving major tag for this PSModule-owned workflow. On 2026-08-15, `v8`, `v8.0`,
154
154
and the immutable `v8.0.0` release tag all resolve to commit `5a11e8e8b018faf97017e0416f136a751c026713`.
@@ -191,21 +191,15 @@ fleet campaign. Branch names, `latest`, floating minor tags, and unqualified tar
191
191
| Credentials | Explicitly map the three required secrets. | Satisfies the `v7+` contract and prevents unrelated secret inheritance. |
192
192
| Scope | Require one conforming `Process-PSModule` delegation job. | Additional repository-owned jobs do not change caller conformance. |
193
193
194
-
## Candidate optional elements
194
+
## Allowed caller variation
195
195
196
-
These are evidence-based candidate variations, not approved policy.
196
+
The only conforming variation from the canonical template is the optional `TestData` secret mapping shown above.
197
+
Callers use it only when module-local tests need caller-defined secrets or variables, and expose only the required
198
+
values in the documented `secrets` and `variables` maps.
197
199
198
-
| Option | When it is appropriate | Constraint |
199
-
| --- | --- | --- |
200
-
| `TestData` secret | Module-local tests need caller-defined secrets or variables. | Optionally map the documented JSON object with separate `secrets` and `variables` maps, exposing only required values. |
201
-
| `with.SettingsPath` | The settings file is not `.github/PSModule.yml`. | Prefer the standard path for normal module repositories. |
202
-
| `with.WorkingDirectory` | The module is intentionally rooted below the repository root. | Keep the default `.` for the standard layout. |
203
-
| `with.ImportantFilePatterns` | A caller must override change detection at the workflow boundary. | Prefer stable configuration in `.github/PSModule.yml`; the supplied list replaces all defaults. |
204
-
| `with.Verbose`, `Version`, or `Prerelease` | A deliberate diagnostic or dependency-selection scenario needs it. | Do not hard-code temporary diagnostics into the fleet baseline. |
205
-
| Schedule time | Health runs need staggering or a repository-specific maintenance window. | Keep at least one documented schedule unless the repository records why health runs are unnecessary. |
206
-
| `run-name` | A repository needs clearer run presentation. | Presentation must not change job names or routing behavior. |
207
-
208
-
Conforming callers do not set `with.Debug: true`; the reusable workflow default remains `false`.
200
+
Every other field in the Process-PSModule caller contract matches the template exactly. Callers do not add `with:`
201
+
inputs, change schedule timing, add `run-name`, add a caller condition, or broaden permissions. Repository-owned jobs
202
+
may coexist because they are outside the Process-PSModule caller contract; they do not modify the canonical call.
209
203
210
204
## Variations requiring a decision
211
205
@@ -220,6 +214,10 @@ an approved structure:
220
214
- a concurrency key other than workflow plus PR number or full ref, or cancellation behavior other than pull-request-only;
221
215
- a caller-level fork or event-authorization condition;
222
216
- trigger-level path filters that bypass Process-PSModule important-file evaluation;
217
+
- any `with:` input, including `Debug`, `ImportantFilePatterns`, `Prerelease`, `SettingsPath`, `Verbose`, `Version`, or
218
+
`WorkingDirectory`;
219
+
- a schedule other than the canonical `0 0 * * *`;
0 commit comments