Skip to content

Commit fb5469c

Browse files
committed
docs: moves examples to separate repository.
Moved to https://github.com/imposter-project/examples
1 parent 4671653 commit fb5469c

File tree

191 files changed

+53
-5226
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+53
-5226
lines changed

.github/dependabot.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,6 @@ updates:
2727
prefix: "chore"
2828
include: "scope"
2929

30-
- package-ecosystem: maven
31-
directory: "/examples/junit-sample"
32-
schedule:
33-
interval: "daily"
34-
target-branch: "develop"
35-
open-pull-requests-limit: 4
36-
labels:
37-
- "dependencies"
38-
- "examples"
39-
commit-message:
40-
prefix: "chore"
41-
include: "scope"
42-
4330
- package-ecosystem: docker
4431
directory: "/"
4532
schedule:

.github/workflows/examples.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ jobs:
88
contents: write
99
steps:
1010
- uses: actions/checkout@v4
11+
12+
- name: Remove placeholder examples directory
13+
run: rm -rf examples
14+
15+
- name: Checkout examples
16+
uses: actions/checkout@v4
17+
with:
18+
repository: 'imposter-project/examples'
19+
path: 'examples'
1120

1221
- name: Setup Java
1322
uses: actions/setup-java@v4

docs/benchmarks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ Configuration and commands to allow benchmarks to be independently reproduced.
5353

5454
#### Scenarios
5555

56-
- Scenario 1: Static, configuration-driven: [examples/rest/simple](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/simple)
57-
- Scenario 2: Conditional, configuration-driven: [examples/rest/conditional-config](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-config)
58-
- Scenario 3: Dynamic, script-driven: [examples/rest/conditional-scripted](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-scripted)
56+
- Scenario 1: Static, configuration-driven: [examples/rest/simple](https://github.com/imposter-project/examples/blob/main/rest/simple)
57+
- Scenario 2: Conditional, configuration-driven: [examples/rest/conditional-config](https://github.com/imposter-project/examples/blob/main/rest/conditional-config)
58+
- Scenario 3: Dynamic, script-driven: [examples/rest/conditional-scripted](https://github.com/imposter-project/examples/blob/main/rest/conditional-scripted)
5959

6060
#### Start command
6161

docs/bundle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,5 +144,5 @@ $ docker run --rm -it -p 8080:8080 example/mocks
144144

145145
This is a standard Docker container image, so you can push it to a registry and run it anywhere Docker runs.
146146

147-
> See [the Docker example project](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/docker) for a working example.
147+
> See [the Docker example project](https://github.com/imposter-project/examples/tree/main/docker) for a working example.
148148

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ resources:
150150

151151
In this example, responses to both `/example1` and `/example2` will have the header `X-Always-Present: Yes` set, as it is inherited from the root configuration.
152152

153-
> See [default-response-config](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/default-response-config) for an example.
153+
> See [default-response-config](https://github.com/imposter-project/examples/blob/main/rest/default-response-config) for an example.
154154

155155
#### Default response values
156156

docs/cors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ cors:
7272

7373
## Examples
7474

75-
- [cors-automatic](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/cors-automatic/)
75+
- [cors-automatic](https://github.com/imposter-project/examples/blob/main/rest/cors-automatic/)

docs/data_capture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,4 +425,4 @@ Using JsonPath to capture the request body is computationally expensive, as it r
425425

426426
## Examples
427427

428-
- [data-capture](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/data-capture)
428+
- [data-capture](https://github.com/imposter-project/examples/blob/main/rest/data-capture)

docs/embed_jvm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Imposter starts before your test runs, such as in your test set-up method (e.g.
88

99
## Getting started
1010

11-
> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/junit-sample)
11+
> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/examples/tree/main/junit-sample)
1212
1313
First, note the latest [release version](https://github.com/imposter-project/imposter-jvm-engine/releases).
1414

@@ -49,7 +49,7 @@ String mockEndpoint = imposter.getBaseUrl() + "/v1/pets";
4949
// simulated HTTP responses, in place of a real endpoint.
5050
```
5151

52-
> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/junit-sample)
52+
> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/examples/tree/main/junit-sample)
5353
5454
## Using a full configuration file
5555

docs/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
See [examples](../../examples).
1+
See [examples](https://github.com/imposter-project/examples).

docs/fake_data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Some common examples:
5656
5757
#### Try it out
5858

59-
See the [example directory](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/fake-data) for a working example.
59+
See the [example directory](https://github.com/imposter-project/examples/blob/main/rest/fake-data) for a working example.
6060

6161
```bash
6262
curl http://localhost:8080/users/1
@@ -80,7 +80,7 @@ When using the `fake-data` plugin with the OpenAPI plugin, common property names
8080

8181
#### Try it out
8282

83-
See the [example directory](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/fake-data) for a working example.
83+
See the [example directory](https://github.com/imposter-project/examples/blob/main/openapi/fake-data) for a working example.
8484

8585
For example:
8686

0 commit comments

Comments
 (0)