Updated the docs
This commit is contained in:
13
README.adoc
13
README.adoc
@@ -294,4 +294,17 @@ Build both Maven and Gradle projects and run tests on standalone projects
|
||||
|
||||
```
|
||||
./scripts/buildAndTest.sh
|
||||
```
|
||||
```
|
||||
|
||||
Generate documentation
|
||||
|
||||
```
|
||||
./scripts/generateDocs.sh
|
||||
```
|
||||
|
||||
Publish documentation to `gh-pages`
|
||||
|
||||
```
|
||||
./docs/src/main/asciidoc/ghpages.sh
|
||||
```
|
||||
@@ -60,3 +60,16 @@ Build both Maven and Gradle projects and run tests on standalone projects
|
||||
```
|
||||
./scripts/buildAndTest.sh
|
||||
```
|
||||
```
|
||||
|
||||
Generate documentation
|
||||
|
||||
```
|
||||
./scripts/generateDocs.sh
|
||||
```
|
||||
|
||||
Publish documentation to `gh-pages`
|
||||
|
||||
```
|
||||
./docs/src/main/asciidoc/ghpages.sh
|
||||
```
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Sample more complex configuration for Java Project with JUnit tests.
|
||||
|
||||
|
||||
=== Project configuration for Accurest with JUnit tests and stub publishing
|
||||
=== Project configuration for Spring Cloud Contract Verifier with JUnit tests and stub publishing
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
|
||||
@@ -9,7 +9,7 @@ Sample minimal configuration for Java Project with JUnit tests.
|
||||
include::../../../src/test/projects/spring-boot-java/pom.xml[tags=dependencies]
|
||||
----
|
||||
|
||||
=== Project configuration for Accurest with JUnit tests and stub publishing
|
||||
=== Project configuration for Spring Cloud Contract Verifier with JUnit tests and stub publishing
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
@@ -26,4 +26,4 @@ include::../../../src/test/projects/spring-boot-java/src/test/java/hello/BaseAcc
|
||||
|
||||
=== Project source code
|
||||
|
||||
https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-java
|
||||
https://github.com/spring-cloud/spring-cloud-contract/tree/master/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java
|
||||
@@ -9,7 +9,7 @@ Sample minimal configuration for Groovy Project with Spock Specification
|
||||
include::../../../src/test/projects/spring-boot-groovy/pom.xml[tags=dependencies]
|
||||
----
|
||||
|
||||
=== Project configuration for Accurest, Groovy, Spock specifications and stub publishing
|
||||
=== Project configuration for Spring Cloud Contract Verifier, Groovy, Spock specifications and stub publishing
|
||||
|
||||
|
||||
[source,xml]
|
||||
@@ -26,4 +26,4 @@ include::../../../src/test/projects/spring-boot-groovy/src/test/groovy/hello/Bas
|
||||
|
||||
=== Project source code
|
||||
|
||||
https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-groovy
|
||||
https://github.com/spring-cloud/spring-cloud-contract/tree/master/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
= Usage
|
||||
|
||||
== Converting Accurest GroovyDSL into WireMock stub mappings
|
||||
== Converting Spring Cloud Contract DSL into WireMock stub mappings
|
||||
|
||||
mvn org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:convert
|
||||
|
||||
or shortly footnoteref:[prefix,Additional configuration inside `~/.m2/settings.xml` is required: `<pluginGroups><pluginGroup>io.codearte.accurest</pluginGroup></pluginGroups>`.]
|
||||
or shortly footnoteref:[prefix,Additional configuration inside `~/.m2/settings.xml` is required: `<pluginGroups><pluginGroup>io.codearte.Spring Cloud Contract</pluginGroup></pluginGroups>`.]
|
||||
|
||||
mvn spring-cloud-contract-verifier:convert
|
||||
|
||||
For more information please go to the Accurest Wiki or Plugin Documentation Site.
|
||||
For more information please go to the Spring Cloud Contract Wiki or Plugin Documentation Site.
|
||||
|
||||
== Accurest Stub Runner
|
||||
== Spring Cloud Contract Stub Runner
|
||||
|
||||
Run stubs mappings from current directory:
|
||||
|
||||
@@ -24,7 +24,7 @@ or shortly footnoteref:[prefix]
|
||||
|
||||
mvn spring-cloud-contract-verifier:run -Dstubs="org.springframework:gs-rest-service"
|
||||
|
||||
where `org.springframework:gs-rest-service` is artifact with stubs classifier contains wiremock mappings.
|
||||
where `org.springframework:gs-rest-service` is artifact with stubs classifier contains WireMock mappings.
|
||||
|
||||
== Project configuration
|
||||
|
||||
|
||||
Reference in New Issue
Block a user