Skip to content

Commit

Permalink
Merge pull request #5736 from aureamunoz/doc-use-locally-built-issue-…
Browse files Browse the repository at this point in the history
…5687

doc: document how to use 999-SNAPSHOT of quarkus
  • Loading branch information
aloubyansky authored Nov 26, 2019
2 parents 99e00a6 + 4dec5b8 commit c6e78b7
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/src/main/asciidoc/maven-tooling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,18 @@ The following table lists the attributes you can pass to the `create` command:
| `1.0-SNAPSHOT`
| The version of the created project

| `platformGroupId`
| `io.quarkus`
| The group id of the target platform. Given that all the existing platforms are coming from `io.quarkus` this one won't practically be used explicitly. But it's still an option.

| `platformArtifactId`
| `quarkus-universe-bom`
| The artifact id of the target platform BOM. It should be `quarkus-bom` in order to use the locally built Quarkus.

| `platformVersion`
| If it's not specified, the latest one will be resolved.
| The version of the platform you want the project to use. It can also accept a version range, in which case the latest from the specified range will be used.

| `className`
| _Not created if omitted_
| The fully qualified name of the generated resource
Expand All @@ -58,6 +70,8 @@ The following table lists the attributes you can pass to the `create` command:

|===

By default, the command will target the latest version of `quarkus-universe-bom` (unless specific coordinates have been specified). If you run offline however, it will look for the latest locally available and if `quarkus-universe-bom` (satisfying the default version range which is currently up to 2.0) is not available locally, it will fallback to the bundled platform based on `quarkus-bom` (the version will match the version of the plugin).

If you decide to generate a REST resource (using the `className` attribute), the endpoint is exposed at: `http://localhost:8080/$path`.
If you use the default `path`, the URL is: http://localhost:8080/hello.

Expand Down

0 comments on commit c6e78b7

Please sign in to comment.