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
docs: trim README verify section, keep detail in docs file
README now has just the usage example and parameter table.
Detailed job descriptions, regression testing, secrets, and
usage variants are in docs/verify-workflow.md.
Copy file name to clipboardExpand all lines: README.md
+4-33Lines changed: 4 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,12 +139,10 @@ When `msi: false`, the `GORELEASER_PRO_KEY` secret is not required.
139
139
140
140
## Verify Workflow
141
141
142
-
Runs linting, tests, and optional regression verification for connector repositories. See [detailed documentation](docs/verify-workflow.md) for all options.
142
+
Runs linting, tests, and optional regression verification. See [detailed documentation](docs/verify-workflow.md) for jobs, regression testing, and all options.
The verify workflow accepts the following parameters:
167
-
168
165
| Parameter | Required | Default | Description |
169
166
|-|-|-|-|
170
167
| `ref` | Yes | - | Git ref to check out and verify |
171
-
| `run_tests` | No | `true` | Whether to run `go test` |
172
-
| `connector` | No | `""` | Connector name for regression testing (e.g., `baton-okta`). If set, runs baton-regression verification |
173
-
174
-
### Jobs
175
-
176
-
The workflow runs up to three jobs:
177
-
178
-
1. **lint** — runs `golangci-lint` on the caller repo
179
-
2. **test** — runs `go test` (skipped if `run_tests: false`)
180
-
3. **regression** — runs [baton-regression](https://github.com/ConductorOne/baton-regression) verification (only when `connector` is provided)
181
-
182
-
### Regression Testing
183
-
184
-
When `connector` is provided, the verify workflow calls the baton-regression reusable workflow to run structural verification against the connector. This checks axiom compliance, branch coverage, and nil pointer safety.
The `secrets: inherit` directive is required so that `RELENG_GITHUB_TOKEN` flows through to the regression workflow for private repo access.
197
-
198
-
To disable regression for a connector that isn't ready, omit the `connector` parameter (controlled via `run_regression: false` in baton-admin's `connectors.yaml`).
168
+
| `run_tests` | No | `true` | Run `go test` |
169
+
| `connector` | No | `""` | Connector name — triggers [regression testing](docs/verify-workflow.md#regression) when set |
0 commit comments