docs: moves examples to separate repository.

Moved to https://github.com/imposter-project/examples

Author: outofcoffee

.github/dependabot.yml

@@ -27,19 +27,6 @@ updates:
       prefix: "chore"
       include: "scope"
 
-  - package-ecosystem: maven
-    directory: "/examples/junit-sample"
-    schedule:
-      interval: "daily"
-    target-branch: "develop"
-    open-pull-requests-limit: 4
-    labels:
-      - "dependencies"
-      - "examples"
-    commit-message:
-      prefix: "chore"
-      include: "scope"
-
   - package-ecosystem: docker
     directory: "/"
     schedule:

.github/workflows/examples.yaml

@@ -8,6 +8,15 @@ jobs:
       contents: write
     steps:
       - uses: actions/checkout@v4
+      
+      - name: Remove placeholder examples directory
+        run: rm -rf examples
+      
+      - name: Checkout examples
+        uses: actions/checkout@v4
+        with:
+          repository: 'imposter-project/examples'
+          path: 'examples'
 
       - name: Setup Java
         uses: actions/setup-java@v4

docs/benchmarks.md

@@ -53,9 +53,9 @@ Configuration and commands to allow benchmarks to be independently reproduced.
 
 #### Scenarios
 
-- Scenario 1: Static, configuration-driven: [examples/rest/simple](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/simple)
-- Scenario 2: Conditional, configuration-driven: [examples/rest/conditional-config](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-config)
-- Scenario 3: Dynamic, script-driven: [examples/rest/conditional-scripted](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-scripted)
+- Scenario 1: Static, configuration-driven: [examples/rest/simple](https://github.com/imposter-project/examples/blob/main/rest/simple)
+- Scenario 2: Conditional, configuration-driven: [examples/rest/conditional-config](https://github.com/imposter-project/examples/blob/main/rest/conditional-config)
+- Scenario 3: Dynamic, script-driven: [examples/rest/conditional-scripted](https://github.com/imposter-project/examples/blob/main/rest/conditional-scripted)
 
 #### Start command
 

docs/bundle.md

@@ -144,5 +144,5 @@ $ docker run --rm -it -p 8080:8080 example/mocks
 
 This is a standard Docker container image, so you can push it to a registry and run it anywhere Docker runs.
 
-> See [the Docker example project](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/docker) for a working example.
+> See [the Docker example project](https://github.com/imposter-project/examples/tree/main/docker) for a working example.
 

docs/configuration.md

@@ -150,7 +150,7 @@ resources:
 
 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.
 
-> See [default-response-config](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/default-response-config) for an example.
+> See [default-response-config](https://github.com/imposter-project/examples/blob/main/rest/default-response-config) for an example.
 
 #### Default response values
 

docs/cors.md

@@ -72,4 +72,4 @@ cors:
 
 ## Examples
 
-- [cors-automatic](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/cors-automatic/)
+- [cors-automatic](https://github.com/imposter-project/examples/blob/main/rest/cors-automatic/)

docs/data_capture.md

@@ -425,4 +425,4 @@ Using JsonPath to capture the request body is computationally expensive, as it r
 
 ## Examples
 
-- [data-capture](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/data-capture)
+- [data-capture](https://github.com/imposter-project/examples/blob/main/rest/data-capture)

docs/embed_jvm.md

@@ -8,7 +8,7 @@ Imposter starts before your test runs, such as in your test set-up method (e.g.
 
 ## Getting started
 
-> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/junit-sample)
+> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/examples/tree/main/junit-sample)
 
 First, note the latest [release version](https://github.com/imposter-project/imposter-jvm-engine/releases).
 
@@ -49,7 +49,7 @@ String mockEndpoint = imposter.getBaseUrl() + "/v1/pets";
 // simulated HTTP responses, in place of a real endpoint.
 ```
 
-> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/junit-sample)
+> For a full working example project, see [examples/junit-sample](https://github.com/imposter-project/examples/tree/main/junit-sample)
 
 ## Using a full configuration file
 

docs/examples/README.md

@@ -1 +1 @@
-See [examples](../../examples).
+See [examples](https://github.com/imposter-project/examples).

docs/fake_data.md

@@ -56,7 +56,7 @@ Some common examples:
 
 #### Try it out
 
-See the [example directory](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/fake-data) for a working example.
+See the [example directory](https://github.com/imposter-project/examples/blob/main/rest/fake-data) for a working example.
 
 ```bash
 curl http://localhost:8080/users/1
@@ -80,7 +80,7 @@ When using the `fake-data` plugin with the OpenAPI plugin, common property names
 
 #### Try it out
 
-See the [example directory](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/fake-data) for a working example.
+See the [example directory](https://github.com/imposter-project/examples/blob/main/openapi/fake-data) for a working example.
 
 For example:
 

docs/groovy_tips.md

@@ -123,8 +123,8 @@ For more sophisticated script development, you can set up a project in your IDE
 
 This requires setting up a project with a dependency on `imposter-api.jar` and adding the GroovyDSL (GDSL) file.
 
-➡️ [See an example project](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/groovy-dsl)
+➡️ [See an example project](https://github.com/imposter-project/examples/tree/main/groovy-dsl)
 
 If you just want to download the GDSL file see:
 
-➡️ [Download the GDSL file](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples/groovy-dsl/src/main/resources/imposter.gdsl) 
+➡️ [Download the GDSL file](https://github.com/imposter-project/examples/tree/main/groovy-dsl/src/main/resources/imposter.gdsl) 

docs/index.md

@@ -41,7 +41,7 @@ To begin, check out the [Getting started](getting_started.md) guide. See the _Co
 - [JavaScript scripting tips](javascript_tips.md)
 - [Groovy scripting tips](groovy_tips.md)
 - [JavaScript compatibility](scripting_modern_js.md)
-- [Examples](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples)
+- [Examples](https://github.com/imposter-project/examples/tree/main)
 
 ### Data capture and storage
 

docs/interceptors.md

@@ -120,5 +120,5 @@ Both interceptors store data, which is later used by the `/example` resource.
 
 See the following examples:
 
-- See [examples/rest/interceptors-simple](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/interceptors-simple) for a short-circuit example.
-- See [examples/rest/interceptors-passthrough](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/interceptors-passthrough) for a passthrough example.
+- See [examples/rest/interceptors-simple](https://github.com/imposter-project/examples/blob/main/rest/interceptors-simple) for a short-circuit example.
+- See [examples/rest/interceptors-passthrough](https://github.com/imposter-project/examples/blob/main/rest/interceptors-passthrough) for a passthrough example.

docs/metrics_logs_telemetry.md

@@ -58,7 +58,7 @@ Other useful metrics:
 | script_execution_duration   | Script engine execution duration in seconds |
 | script_cache_entries        | The number of cached compiled scripts       |
 
-> Also see [the metrics example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/metrics).
+> Also see [the metrics example](https://github.com/imposter-project/examples/blob/main/metrics).
 
 ## Logs
 

docs/openapi_plugin.md

@@ -152,7 +152,7 @@ Once you're finished, stop the server with CTRL+C.
 
 > For more working examples, see:
 >
-> * [examples/openapi](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi)
+> * [examples/openapi](https://github.com/imposter-project/examples/blob/main/openapi)
 
 ## Validating requests against the specification
 
@@ -327,7 +327,7 @@ HTTP/1.1 400 Bad Request
 
 ## Object response examples
 
-Imposter has basic support for response examples defined as objects, for example an API specification like `object-examples.yaml` - see [examples/openapi/object-examples](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/object-examples).
+Imposter has basic support for response examples defined as objects, for example an API specification like `object-examples.yaml` - see [examples/openapi/object-examples](https://github.com/imposter-project/examples/blob/main/openapi/object-examples).
 
 The salient part of the response is as follows:
 
@@ -402,7 +402,7 @@ For more advanced scenarios, you can also control Imposter's responses using Jav
 
 > See the [Scripting](scripting.md) section for more information.
 
-For a simple script, see [examples/openapi/scripted-named-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/scripted-named-example) for a working example.
+For a simple script, see [examples/openapi/scripted-named-example](https://github.com/imposter-project/examples/blob/main/openapi/scripted-named-example) for a working example.
 
 ### Additional context objects
 
@@ -484,9 +484,9 @@ paths:
 
 #### Examples
 
-- [scripted-named-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/scripted-named-example)
-- [scripted-named-example-js](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/scripted-named-example-js)
-- [static-named-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/static-named-example)
+- [scripted-named-example](https://github.com/imposter-project/examples/blob/main/openapi/scripted-named-example)
+- [scripted-named-example-js](https://github.com/imposter-project/examples/blob/main/openapi/scripted-named-example-js)
+- [static-named-example](https://github.com/imposter-project/examples/blob/main/openapi/static-named-example)
 
 ### Configuration reference
 

docs/openapi_validation.md

@@ -71,7 +71,7 @@ This is because in the corresponding part of the OpenAPI specification, both the
 
 Note that if the request body were provided, its structure would be validated against the corresponding schema entry.
 
-See [examples/openapi/request-validation](https://github.com/imposter-project/imposter-jvm-engine/blob/master/examples/openapi/request-validation) for a working example.
+See [examples/openapi/request-validation](https://github.com/imposter-project/examples/blob/main/openapi/request-validation) for a working example.
 
 ## Configuring issue behaviour
 

docs/run_imposter_docker.md

@@ -65,7 +65,7 @@ To run Imposter, map the path to the configuration files directory to the `/opt/
 
     docker run -ti -v /path/to/config:/opt/imposter/config -p 8080:8080 outofcoffee/imposter
 
-> To get up and running quickly, see the [examples](https://github.com/imposter-project/imposter-jvm-engine/tree/main/examples).
+> To get up and running quickly, see the [examples](https://github.com/imposter-project/examples/tree/main).
 
 ### Example
 
@@ -142,7 +142,7 @@ However, it is possible to build container images and use shell commands in a Do
 
 > **An example**
 > 
-> Here is an example of a custom Docker image: https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/docker/Dockerfile
+> Here is an example of a custom Docker image: https://github.com/imposter-project/examples/blob/main/docker/Dockerfile
 >
 > This example extends from the Java base image so has its various userspace tools available (and more you can install with the package manager).
 

docs/scripting.md

@@ -34,7 +34,7 @@ For example:
     201 Created
 
 > **Note**
-> See this [rest plugin example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-scripted) for a simple example.
+> See this [rest plugin example](https://github.com/imposter-project/examples/blob/main/rest/conditional-scripted) for a simple example.
 
 ### Another example
 
@@ -258,7 +258,7 @@ respond().withExampleName('example1')
 This selects the example from the OpenAPI `examples` section for the API response.
 
 > **Note**
-> See this [openapi plugin example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/scripted-named-example) for a simple example.
+> See this [openapi plugin example](https://github.com/imposter-project/examples/blob/main/openapi/scripted-named-example) for a simple example.
 
 ### Using stores
 

docs/scripting_legacy_js.md

@@ -63,4 +63,4 @@ curl -i http://localhost:8080/pets
 ]
 ```
 
-* See the `examples/rest/conditional-scripted` directory [in GitHub](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/conditional-scripted).
+* See the `examples/rest/conditional-scripted` directory [in GitHub](https://github.com/imposter-project/examples/blob/main/rest/conditional-scripted).

docs/scripting_modern_js.md

@@ -18,7 +18,7 @@ To use the GraalVM JavaScript engine, you need to be running Imposter v4.0.0 or
 
 ## Examples
 
-For examples, see the `examples/graal` directory [in GitHub](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/graal).
+For examples, see the `examples/graal` directory [in GitHub](https://github.com/imposter-project/examples/blob/main/graal).
 
 ### Simple example
 
@@ -38,7 +38,7 @@ Hello Ada
 
 ### Advanced example
 
-See the `examples/graal/es6` [directory](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/graal) for an example of using modern JavaScript features in a script.
+See the `examples/graal/es6` [directory](https://github.com/imposter-project/examples/blob/main/graal) for an example of using modern JavaScript features in a script.
 
 ---
 

docs/security.md

@@ -246,5 +246,5 @@ resources:
 
 See the `examples` directory for working sample configurations, such as:
 
-* [Simple authentication](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/authentication-simple)
-* [Extended authentication](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/openapi/authentication-extended)
+* [Simple authentication](https://github.com/imposter-project/examples/blob/main/openapi/authentication-simple)
+* [Extended authentication](https://github.com/imposter-project/examples/blob/main/openapi/authentication-extended)

docs/soap_plugin.md

@@ -156,7 +156,7 @@ Once you're finished, stop the server with CTRL+C.
 
 > For more working examples, see:
 >
-> * [examples/soap](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap)
+> * [examples/soap](https://github.com/imposter-project/examples/blob/main/soap)
 
 ## Conditional responses
 
@@ -248,15 +248,15 @@ resources:
 
 > **Tip**
 > Use conditional matching with resources, to only return a fault in particular circumstances.
-> See [fault-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap/fault-example) for an example of how to do this.
+> See [fault-example](https://github.com/imposter-project/examples/blob/main/soap/fault-example) for an example of how to do this.
 
 ## Scripted responses (advanced)
 
 For more advanced scenarios, you can also control Imposter's responses using JavaScript or Groovy scripts.
 
 > See the [Scripting](scripting.md) section for more information.
 
-For a simple script, see [examples/soap/scripted-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap/scripted-example) for a working example.
+For a simple script, see [examples/soap/scripted-example](https://github.com/imposter-project/examples/blob/main/soap/scripted-example) for a working example.
 
 ### Additional context objects
 
@@ -317,9 +317,9 @@ respond().withStatusCode(500)
 
 #### Scripting examples
 
-- [conditional-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap/conditional-example)
-- [scripted-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap/scripted-example)
-- [fault-example](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/soap/fault-example)
+- [conditional-example](https://github.com/imposter-project/examples/blob/main/soap/conditional-example)
+- [scripted-example](https://github.com/imposter-project/examples/blob/main/soap/scripted-example)
+- [fault-example](https://github.com/imposter-project/examples/blob/main/soap/fault-example)
 
 ### Configuration reference
 

docs/template_queries.md

@@ -68,4 +68,4 @@ Using JsonPath in placeholder templates is computationally expensive, as it requ
 
 ## Examples
 
-- [response-template](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/response-template)
+- [response-template](https://github.com/imposter-project/examples/blob/main/rest/response-template)

docs/templates.md

@@ -360,4 +360,4 @@ Template files are cached in memory once read from disk, so they do not incur as
 
 ## Examples
 
-- [response-template](https://github.com/imposter-project/imposter-jvm-engine/blob/main/examples/rest/response-template)
+- [response-template](https://github.com/imposter-project/examples/blob/main/rest/response-template)

examples/README.md

@@ -1,5 +1 @@
-# Imposter examples
-
-Sample configuration files for various scenarios.
-
-> See [the documentation](https://docs.imposter.sh) for more detail.
+See [examples](https://github.com/imposter-project/examples).