diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 0468595639..0000000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security Policy - -## Reporting a Vulnerability - -To report security vulnerabilities, please go to https://pivotal.io/security. diff --git a/docs/src/main/asciidoc/_building.adoc b/docs/src/main/asciidoc/_building.adoc index 57c00a928d..6a4eb1cc6c 100644 --- a/docs/src/main/asciidoc/_building.adoc +++ b/docs/src/main/asciidoc/_building.adoc @@ -1,5 +1,38 @@ == How to Build Spring Cloud Contract +=== Cloning the repository on Windows + +While cloning this project on Windows, some files in the git repository may exceed the Windows maximum file path limit of 255 characters, which may +result in an incorrectly (probably partially) checked out repository. + +To resolve this issue, you can set the `core.longPaths` attribute to `true` or clone the Spring Cloud Contract repository. + +To set the `core.longPaths` attribute to `true`, you have three options: + +- Change it for all users of the machine (doing so requires administrator privileges): + + +[source,bash] +---- +git config --system core.longPaths true +git clone https://github.com/spring-cloud/spring-cloud-contract.git +---- + +- Change it for the current user (no administrative privileges required): + +[source,bash] +---- +git config --global core.longPaths true +git clone https://github.com/spring-cloud/spring-cloud-contract.git +---- + +- Change for just this repository (administrative privileges depend on where the repository is being cloned to): + +[source,bash] +---- +git clone -c core.longPaths true https://github.com/spring-cloud/spring-cloud-contract.git +---- + IMPORTANT: You need to have all the necessary Groovy plugins installed for your IDE to properly resolve the sources. For example, in Intellij IDEA, having both the Eclipse Groovy Compiler Plugin and the GMavenPlus Intellij @@ -80,7 +113,7 @@ run the following command: ./scripts/parallelBuild.sh ``` -To use eight 8 cores, run thke following command: +To use eight 8 cores, run the following command: ``` CORES=8 ./scripts/parallelBuild.sh diff --git a/spring-cloud-contract-wiremock/src/main/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMock.java b/spring-cloud-contract-wiremock/src/main/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMock.java index 72154793b9..3e667e4c19 100644 --- a/spring-cloud-contract-wiremock/src/main/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMock.java +++ b/spring-cloud-contract-wiremock/src/main/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMock.java @@ -46,12 +46,50 @@ import org.springframework.context.annotation.Import; @Inherited public @interface AutoConfigureWireMock { + /** + * Configures WireMock instance to listen on specified port. + *
+ * Set this value to 0 for WireMock to listen to a random port. + *
+ * @return port to which WireMock instance should listen to + */ int port() default 8080; + /** + * If specified, configures WireMock instance to enable HTTPS on specified + * port. + *+ * Set this value to 0 for WireMock to listen to a random port. + *
+ * @return port to which WireMock instance should listen to + */ int httpsPort() default -1; + /** + * The resource locations to use for loading WireMock mappings. + *+ * When none specified, src/test/resources/mappings is used as default + * location. + *
+ *+ * To customize the location, this attribute must be set to the directory where + * mappings are stored. + *
+ * @return locations to read WireMock mappings from + */ String[] stubs() default { "" }; + /** + * The resource locations to use for loading WireMock response bodies. + *+ * When none specified, src/test/resources/__files is used as default. + *
+ *+ * To customize the location, this attribute must be set to the parent directory of + * __files directory. + *
+ * @return locations to read WireMock response bodies from + */ String[] files() default { "" }; }