Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ Starts the Imposter mock server in the background, and waits for it to be ready.
- `base-url`: Base URL of the mock server (e.g. `http://localhost:8080`)

### 3. Stop Mocks (`stop-mocks`)
Stops the running Imposter mock server.
Stops all running Imposter mock servers, regardless of engine type.

```yaml
- uses: imposter-project/imposter-github-action/stop-mocks@v1
with:
# Optional: Type of mock engine to use (jvm or docker)
engine-type: 'docker' # default: 'docker'
```

> [!NOTE]
> The `engine-type` input is deprecated and ignored; all managed mocks are stopped regardless of engine type.

## Sample Workflow

Here's a complete example showing how to use all three actions in a workflow:
Expand Down Expand Up @@ -101,8 +101,6 @@ jobs:
# Stop mock server
- name: Stop Mocks
uses: imposter-project/imposter-github-action/stop-mocks@v1
with:
engine-type: 'docker' # Should match the engine-type used in start-mocks
```

## Configuration
Expand Down
13 changes: 9 additions & 4 deletions stop-mocks/action.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
name: 'Stop Imposter Mocks'
description: 'Stops the running Imposter mock server'
description: 'Stops all running Imposter mock servers'

inputs:
engine-type:
description: 'Type of mock engine to use (jvm or docker)'
description: 'Deprecated and ignored. All managed mocks are stopped regardless of engine type.'
required: false
default: 'docker'
deprecationMessage: "The 'engine-type' input is deprecated and no longer used; all managed mocks are stopped regardless of engine type."

runs:
using: "composite"
steps:
- name: Warn on deprecated engine-type input
if: ${{ inputs.engine-type != '' }}
shell: bash
run: echo "::warning title=Deprecated input::The 'engine-type' input of stop-mocks is deprecated and no longer used; all managed mocks are stopped regardless of engine type."

- name: Stop Imposter server
shell: bash
run: imposter down -t ${{ inputs.engine-type }}
run: imposter down --all
Loading