Skip to content

Commit c71451a

Browse files
committed
docs: use outputs.url in GitHub Action examples, fix llmock binary name
1 parent a44f73f commit c71451a

3 files changed

Lines changed: 18 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66

77
- **Snapshot-style recording** — When `X-Test-Id` is present, recorded fixtures are saved to `<fixturePath>/<slugified-testId>/<provider>.json` instead of timestamp-based filenames. Multiple fixtures for the same test+provider merge into one file. Stable paths enable meaningful PR diffs and easy test-to-fixture mapping. (Feature request by @jantimon, issue #155)
88

9+
### Fixed
10+
11+
- **GitHub Action: cosmetic binary rename**`action.yml` fixtures branch referenced the legacy `llmock` binary (still functional); updated to `aimock` for consistency
12+
- **GitHub Action: hardcoded URLs in docs examples** — All workflow examples now use `steps.<id>.outputs.url` instead of hardcoded `http://127.0.0.1:4010`
13+
914
## [1.18.0] - 2026-05-04
1015

1116
### Added

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ runs:
5858
--host ${{ inputs.host }} \
5959
${{ inputs.args }} &
6060
else
61-
llmock --fixtures "${{ inputs.fixtures }}" \
61+
aimock --fixtures "${{ inputs.fixtures }}" \
6262
--port ${{ inputs.port }} \
6363
--host ${{ inputs.host }} \
6464
${{ inputs.args }} &

docs/github-action/index.html

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,13 @@ <h2>Quick Start</h2>
5858
<div class="code-block">
5959
<div class="code-block-header">workflow.yml <span class="lang-tag">yaml</span></div>
6060
<pre><code>- <span class="prop">uses</span>: <span class="str">CopilotKit/aimock@v1</span>
61+
<span class="prop">id</span>: <span class="str">mock</span>
6162
<span class="prop">with</span>:
6263
<span class="prop">fixtures</span>: <span class="str">./test/fixtures</span>
6364

6465
- <span class="prop">run</span>: <span class="str">pnpm test</span>
6566
<span class="prop">env</span>:
66-
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">http://127.0.0.1:4010/v1</span></code></pre>
67+
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">${{ steps.mock.outputs.url }}/v1</span></code></pre>
6768
</div>
6869

6970
<h2>Inputs</h2>
@@ -138,11 +139,12 @@ <h3>Basic with fixtures</h3>
138139
<pre><code><span class="prop">steps</span>:
139140
- <span class="prop">uses</span>: <span class="str">actions/checkout@v4</span>
140141
- <span class="prop">uses</span>: <span class="str">CopilotKit/aimock@v1</span>
142+
<span class="prop">id</span>: <span class="str">mock</span>
141143
<span class="prop">with</span>:
142144
<span class="prop">fixtures</span>: <span class="str">./fixtures</span>
143145
- <span class="prop">run</span>: <span class="str">npm test</span>
144146
<span class="prop">env</span>:
145-
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">http://127.0.0.1:4010/v1</span></code></pre>
147+
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">${{ steps.mock.outputs.url }}/v1</span></code></pre>
146148
</div>
147149

148150
<h3>Full suite with config</h3>
@@ -151,10 +153,13 @@ <h3>Full suite with config</h3>
151153
<pre><code><span class="prop">steps</span>:
152154
- <span class="prop">uses</span>: <span class="str">actions/checkout@v4</span>
153155
- <span class="prop">uses</span>: <span class="str">CopilotKit/aimock@v1</span>
156+
<span class="prop">id</span>: <span class="str">mock</span>
154157
<span class="prop">with</span>:
155158
<span class="prop">config</span>: <span class="str">./aimock.json</span>
156159
<span class="prop">args</span>: <span class="str">--strict</span>
157-
- <span class="prop">run</span>: <span class="str">npm test</span></code></pre>
160+
- <span class="prop">run</span>: <span class="str">npm test</span>
161+
<span class="prop">env</span>:
162+
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">${{ steps.mock.outputs.url }}/v1</span></code></pre>
158163
</div>
159164

160165
<h3>Record mode (proxy to real APIs)</h3>
@@ -163,12 +168,15 @@ <h3>Record mode (proxy to real APIs)</h3>
163168
<pre><code><span class="prop">steps</span>:
164169
- <span class="prop">uses</span>: <span class="str">actions/checkout@v4</span>
165170
- <span class="prop">uses</span>: <span class="str">CopilotKit/aimock@v1</span>
171+
<span class="prop">id</span>: <span class="str">mock</span>
166172
<span class="prop">with</span>:
167173
<span class="prop">fixtures</span>: <span class="str">./fixtures</span>
168174
<span class="prop">args</span>: <span class="str">--record --provider-openai https://api.openai.com</span>
169175
<span class="prop">env</span>:
170176
<span class="prop">OPENAI_API_KEY</span>: <span class="str">${{ secrets.OPENAI_API_KEY }}</span>
171-
- <span class="prop">run</span>: <span class="str">npm test</span></code></pre>
177+
- <span class="prop">run</span>: <span class="str">npm test</span>
178+
<span class="prop">env</span>:
179+
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">${{ steps.mock.outputs.url }}/v1</span></code></pre>
172180
</div>
173181

174182
<h3>Using the URL output</h3>

0 commit comments

Comments
 (0)