@bensandee/tooling 0.102.0 → 0.104.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -119,6 +119,28 @@ Custom blocks are anchored to the nearest preceding non-blank line. When `repo:s
119
119
 
120
120
  To skip a workflow file entirely, add `# @bensandee/tooling:ignore` as the first line -- `repo:sync` will leave the file untouched.
121
121
 
122
+ ### Trusted runner label
123
+
124
+ By default every generated job runs on `ubuntu-latest`. Set `trustedRunner` in `.tooling.json` to a self-hosted runner label and the default-branch-only jobs move to it:
125
+
126
+ ```json
127
+ { "trustedRunner": "trusted" }
128
+ ```
129
+
130
+ | Job | File | Moves to the label |
131
+ | ------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
132
+ | `check` | `check.yml` (`simple`, `release-it`) / `ci.yml` (`changesets`) | Yes -- the push run on the default branch; pull request runs stay on `ubuntu-latest` |
133
+ | `release` | `release.yml` | Yes -- it only ever runs on the default branch |
134
+ | `post-release-hook` | `ci.yml` (`changesets`) / `release.yml` (`simple`) | Yes -- it only ever runs on the default branch |
135
+
136
+ Pull request jobs stay on `ubuntu-latest` even with the key set. The label itself is the boundary: the forge picks the runner before any step runs, so a job that reaches the shared pool never does so on the trusted runner's machine.
137
+
138
+ Three things to know before setting it:
139
+
140
+ - **Scope the runner.** A job runs on any runner whose label it can name, so the runner must be scoped so no other repository on the forge can name its label. Until it is, setting the key moves your secrets onto a machine other repos can claim.
141
+ - **A missing label hangs the job.** A job aimed at a label no runner serves waits forever. Set the key only once the runner exists and is serving that label.
142
+ - **The move is a workflow edit.** Generated workflows are rewritten on `repo:sync`; setting or removing the key changes nothing until the workflow is regenerated, and removing it likewise does nothing until then. An agent's edit to a generated workflow is held for an operator before it is pushed.
143
+
122
144
  ### pnpm-workspace.yaml
123
145
 
124
146
  `repo:sync` manages `pnpm-workspace.yaml` with a narrow contract -- mandated keys, a few seeded-on-creation keys, and everything else passed through verbatim.