Skip to content

Commit

Permalink
chore(docs): update version in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
andrejpetras committed Oct 25, 2023
1 parent d369e2c commit 5185d97
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:project-version: 1.0.0
:quarkus-version: 3.1.1.Final
:project-version: 1.2.0
:quarkus-version: 3.5.0

:quarkus-mockserver-url: https://github.com/quarkiverse/quarkus-mockserver

Expand Down
30 changes: 25 additions & 5 deletions docs/modules/ROOT/pages/includes/quarkus-mockserver.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.enabled]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.enabled[quarkus.mockserver.devservices.enabled]`


[.description]
--
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -29,6 +31,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.log]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.log[quarkus.mockserver.devservices.log]`


[.description]
--
Enabled or disable log of the mock-server
Expand All @@ -45,6 +48,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.image-name]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.image-name[quarkus.mockserver.devservices.image-name]`


[.description]
--
The container image name to use, for container based DevServices providers.
Expand All @@ -61,9 +65,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.port]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.port[quarkus.mockserver.devservices.port]`


[.description]
--
Optional fixed port the dev service will listen to.
Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -78,10 +84,13 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.shared]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.shared[quarkus.mockserver.devservices.shared]`


[.description]
--
Indicates if the MockServer server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MockServer starts a new container.
The discovery uses the `quarkus-dev-service-mockserver` label. The value is configured using the `service-name` property.
Indicates if the MockServer server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MockServer starts a new container.

The discovery uses the `quarkus-dev-service-mockserver` label. The value is configured using the `service-name` property.

Container sharing is only used in dev mode.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -96,9 +105,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.service-name]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.service-name[quarkus.mockserver.devservices.service-name]`


[.description]
--
The value of the `quarkus-dev-service-mockserver` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Mockserver looks for a container with the `quarkus-dev-service-mockserver` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-mockserver` label set to the specified value.
The value of the `quarkus-dev-service-mockserver` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for Mockserver looks for a container with the `quarkus-dev-service-mockserver` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-mockserver` label set to the specified value.

This property is used when you need multiple shared MockServer servers.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -113,6 +124,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.config-file]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.config-file[quarkus.mockserver.devservices.config-file]`


[.description]
--
MockServer configuration file.
Expand All @@ -129,6 +141,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.config-class-path]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.config-class-path[quarkus.mockserver.devservices.config-class-path]`


[.description]
--
MockServer's configuration class-path binding. Useful for the test and CI builds. When set to `true`, a test-container `withClasspathResourceMapping` method is used.
Expand All @@ -145,6 +158,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.reuse]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.reuse[quarkus.mockserver.devservices.reuse]`


[.description]
--
Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Testcontainers configuration has been explicitly set to allow container reuse. To enable reuse, ass `testcontainers.reuse.enable=true` in your `.testcontainers.properties` file, to be stored in your home.
Expand All @@ -161,6 +175,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-mockserver_quarkus.mockserver.devservices.config-dir]]`link:#quarkus-mockserver_quarkus.mockserver.devservices.config-dir[quarkus.mockserver.devservices.config-dir]`


[.description]
--
The configuration directory to mount in the container /config.
Expand All @@ -177,6 +192,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-mockserver_quarkus.mockserver.host]]`link:#quarkus-mockserver_quarkus.mockserver.host[quarkus.mockserver.host]`


[.description]
--
Host of the MockServer
Expand All @@ -193,6 +209,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-mockserver_quarkus.mockserver.port]]`link:#quarkus-mockserver_quarkus.mockserver.port[quarkus.mockserver.port]`


[.description]
--
Port of the MockServer
Expand All @@ -209,6 +226,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-mockserver_quarkus.mockserver.endpoint]]`link:#quarkus-mockserver_quarkus.mockserver.endpoint[quarkus.mockserver.endpoint]`


[.description]
--
Endpoint of the MockServer
Expand All @@ -225,6 +243,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-mockserver_quarkus.mockserver.client.host]]`link:#quarkus-mockserver_quarkus.mockserver.client.host[quarkus.mockserver.client.host]`


[.description]
--
Host of the MockServer for the MockServerClient
Expand All @@ -241,6 +260,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-mockserver_quarkus.mockserver.client.port]]`link:#quarkus-mockserver_quarkus.mockserver.client.port[quarkus.mockserver.client.port]`


[.description]
--
Port of the MockServer for the MockServerClient
Expand Down

0 comments on commit 5185d97

Please sign in to comment.