Skip to content

Commit cf696c9

Browse files
committed
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.
1 parent 6e87c53 commit cf696c9

1 file changed

Lines changed: 4 additions & 33 deletions

File tree

README.md

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,10 @@ When `msi: false`, the `GORELEASER_PRO_KEY` secret is not required.
139139

140140
## Verify Workflow
141141

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.
143143

144144
### Usage
145145

146-
Create a `.github/workflows/verify.yaml` file:
147-
148146
```yaml
149147
name: Verify
150148
@@ -160,42 +158,15 @@ jobs:
160158
uses: ConductorOne/github-workflows/.github/workflows/verify.yaml@v4
161159
with:
162160
ref: ${{ github.event.pull_request.head.sha || github.sha }}
161+
connector: baton-okta # optional: enables regression testing
163162
secrets: inherit
164163
```
165164

166-
The verify workflow accepts the following parameters:
167-
168165
| Parameter | Required | Default | Description |
169166
|-|-|-|-|
170167
| `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.
185-
186-
```yaml
187-
jobs:
188-
verify:
189-
uses: ConductorOne/github-workflows/.github/workflows/verify.yaml@v4
190-
with:
191-
ref: ${{ github.event.pull_request.head.sha || github.sha }}
192-
connector: baton-okta
193-
secrets: inherit
194-
```
195-
196-
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 |
199170

200171
## Available Actions
201172

0 commit comments

Comments
 (0)