Skip to content

Commit 23ab84b

Browse files
committed
rename spec -> specification
1 parent 22337be commit 23ab84b

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A GitHub Action for running [Bombadil](https://github.com/antithesishq/bombadil)
88
- uses: antithesishq/bombadil-action@v1
99
with:
1010
origin: https://your-app.example.com
11-
spec: ./spec/bombadil.ts
11+
specification: ./bombadil/specification.ts
1212
time-limit: 5m
1313
exit-on-violation: true
1414
output-path: bombadil-output
@@ -33,7 +33,7 @@ Chrome is only installed when `driver: browser`.
3333
- uses: antithesishq/bombadil-action@v1
3434
with:
3535
origin: https://your-app.example.com
36-
spec: ./spec/bombadil.ts
36+
specification: ./bombadil/specification.ts
3737
time-limit: 10m
3838
headers: |
3939
Authorization: Bearer ${{ secrets.STAGING_TOKEN }}
@@ -65,9 +65,9 @@ Chrome is only installed when `driver: browser`.
6565
| Name | Description | Default |
6666
| ---------------------------- | ------------------------------------------------------------------------------------------ | -------- |
6767
| `origin` | Starting URL (also the navigation boundary). **Required.** | |
68-
| `spec` | Path to a TS/JS specification file. | |
69-
| `output-path` | Where to store trace, screenshots, etc. | |
68+
| `specification` | Path to a TS/JS specification file describing the properties to test. | |
7069
| `time-limit` | Maximum run time. Accepts `30s`, `5m`, `2h`, `1d`. **Required.** | |
70+
| `output-path` | Where to store trace, screenshots, etc. | |
7171
| `exit-on-violation` | Exit on the first failing property. | `false` |
7272
| `width` / `height` | Viewport size in pixels. | `1024` / `768` |
7373
| `device-scale-factor` | Viewport scaling factor. | `2` |
@@ -204,7 +204,7 @@ Reproduction is a local workflow. When a test fails, bombadil prints both the `b
204204

205205
3. Use `bombadil inspect ./bombadil-output` to step through what happened.
206206

207-
For reproductions to succeed, run with the same options as the original (viewport, spec file, etc.).
207+
For reproductions to succeed, run with the same options as the original (viewport, specification file, etc.).
208208

209209
## Development
210210

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ inputs:
99
origin:
1010
description: 'Starting URL of the test (also used as a navigation boundary). Required when driver is `browser`.'
1111
required: false
12-
spec:
12+
specification:
1313
description: 'Path to a custom specification file (TypeScript or JavaScript).'
1414
required: false
1515
driver:

src/main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ function splitCommand(raw: string): string[] {
109109
async function run(): Promise<void> {
110110
const driver = parseDriver(core.getInput('driver'));
111111
const origin = core.getInput('origin');
112-
const spec = core.getInput('spec');
112+
const specification = core.getInput('specification');
113113
const version = core.getInput('version') || 'latest';
114114

115115
const flags: string[] = [];
@@ -150,7 +150,7 @@ async function run(): Promise<void> {
150150
throw new Error('The `origin` input is required when driver is "browser".');
151151
}
152152
positionals.push(origin.trim());
153-
if (spec.trim() !== '') positionals.push(spec.trim());
153+
if (specification.trim() !== '') positionals.push(specification.trim());
154154
} else {
155155
const command = core.getInput('command');
156156
if (command.trim() === '') {

0 commit comments

Comments
 (0)