Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: document how to use 999-SNAPSHOT of quarkus #5736

Merged

Conversation

aureamunoz
Copy link
Member

Related to #5687

@aureamunoz
Copy link
Member Author

Hi, here the PR to doc how to be able to generate a project that uses locally built Quarkus. WDYT @geoand @maxandersen @aloubyansky ?

Copy link
Member

@aloubyansky aloubyansky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @aureamunoz There is a small misprint. Could you please fix it?
There actually are other relevant arguments.
-DplatformGroupId is the groupId of the target platform, the default value is io.quarkus, 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.
-DplatformVersion is the version of the platform you want the project to use. If it's not specified, the latest one will be resolved. It can also accept a version range, in which case the latest from the specified range will be used.
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. If quarkus-universe-bom (satisfying the default version range which is currently up to 2.0), it will fallback to the bundled platform based on quarkus-bom (the version will match the version of the plugin).
If you execute the command with

@@ -40,6 +40,10 @@ The following table lists the attributes you can pass to the `create` command:
| _mandatory_
| The artifact id of the created project. Not passing it triggers the interactive mode.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove one of the in The artifact id of the of the....

@aureamunoz
Copy link
Member Author

@aloubyansky do you want also add this paragraphe to the doc? or it's just for clarification?
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. If quarkus-universe-bom (satisfying the default version range which is currently up to 2.0), it will fallback to the bundled platform based on quarkus-bom (the version will match the version of the plugin).
If you execute the command with

@aloubyansky
Copy link
Member

I think it'd be good to mention it. Please correct this phrase

...available. If quarkus-universe-bom (satisfying the default version range which is currently up to 2.0),

to

...available and if quarkus-universe-bom (satisfying the default version range which is currently up to 2.0) is not available locally,

Thank you!

@aureamunoz aureamunoz force-pushed the doc-use-locally-built-issue-5687 branch from c2abd87 to 4dec5b8 Compare November 25, 2019 21:24
@aloubyansky aloubyansky added this to the 1.1.0 milestone Nov 26, 2019
@aloubyansky aloubyansky merged commit c6e78b7 into quarkusio:master Nov 26, 2019
@gsmet gsmet added backport? and removed backport? labels Nov 27, 2019
@gsmet gsmet modified the milestones: 1.1.0, 1.0.1.Final Nov 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants