Skip to content

Commit 100b74d

Browse files
committed
Add delete instructions
1 parent 0b5bcd3 commit 100b74d

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ You can customize the action in `.github/workflows/mockzilla.yml`:
122122
environment: '{"ENV":"production","DEBUG":"true"}' # optional
123123
host: api.mockzilla.net # optional — API host for the simulation URL
124124
timeout-minutes: 5 # optional — max minutes to wait for simulation to become active (default: 5)
125+
delete: false # optional — remove this repository from Mockzilla (default: false)
125126
```
126127
127128
| Input | Required | Description |
@@ -133,3 +134,26 @@ You can customize the action in `.github/workflows/mockzilla.yml`:
133134
| `environment` | no | JSON object of environment variables to set in the simulation (e.g. `'{"ENV":"production"}'`). |
134135
| `host` | no | API host for the simulation URL (`api.mockzilla.org`, `api.mockzilla.de`, or `api.mockzilla.net`). Defaults to org setting or `api.mockzilla.org`. |
135136
| `timeout-minutes` | no | Max minutes the action polls for the simulation to become active. Defaults to `5`. |
137+
| `delete` | no | Remove this repository from Mockzilla. When set to `true`, the action skips publishing and deletes all mock APIs for this repo. Useful on the free plan to free up your slot before connecting a different repository. Defaults to `false`. |
138+
139+
### Removing this repository from Mockzilla
140+
141+
On the free plan you can only have one repository connected to Mockzilla at a time. To switch to a different repo, run the action with `delete: true` on the old one first:
142+
143+
```yaml
144+
name: mockzilla-remove
145+
146+
on:
147+
workflow_dispatch:
148+
149+
jobs:
150+
remove:
151+
runs-on: ubuntu-latest
152+
steps:
153+
- uses: mockzilla/actions/codegen@v1
154+
with:
155+
token: ${{ secrets.GITHUB_TOKEN }}
156+
delete: true
157+
```
158+
159+
Trigger it manually from the **Actions** tab when you're ready.

0 commit comments

Comments
 (0)