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

Quickstart guides for Native Image Build Tools Maven/Gradle plugins. #381

Merged
merged 11 commits into from Jan 9, 2023

Conversation

olyagpl
Copy link
Member

@olyagpl olyagpl commented Dec 21, 2022

Add quickstart guides for beginners, using a “clean” Java project. The guide shows how to create a demo app, enable Maven/Gradle plugin, provide the required configuration, build a native executable, and add and run jUnit tests.

@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 21, 2022
- fix broken links
- fix some unclear instructions and typos
- make Gradle snippets multilanguage
- use a token for the plugin version to keep docs in sync
- fix broken links
- clarify some sections
- add missing unit test
@melix
Copy link
Collaborator

melix commented Dec 23, 2022

@olyagpl I have made some fixes to the docs, checked the instructions step by step and now LGTM!

@olyagpl
Copy link
Member Author

olyagpl commented Jan 2, 2023

@melix, thanks for reviewing and adding Kotlin/Groovy versions!

docs/src/docs/asciidoc/graalvm-setup.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/graalvm-setup.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/graalvm-setup.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/gradle-plugin.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/maven-plugin.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/gradle-plugin-quickstart.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/gradle-plugin-quickstart.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/maven-plugin-quickstart.adoc Outdated Show resolved Hide resolved
docs/src/docs/asciidoc/maven-plugin-quickstart.adoc Outdated Show resolved Hide resolved
olyagpl and others added 2 commits January 5, 2023 13:03
Co-authored-by: Fabio Niephaus <code@fniephaus.com>
Co-authored-by: Fabio Niephaus <code@fniephaus.com>
@olyagpl olyagpl requested a review from fniephaus January 5, 2023 12:32
Copy link
Member

@fniephaus fniephaus left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@olyagpl
Copy link
Member Author

olyagpl commented Jan 9, 2023

@shaunsmith suggestion is also to talk about the GraalVM download scripts in Graalvm-setup.adoc as in the quickstart guides.

The download script will provide the env vars, e.g.,
Run the following to set your $GRAALVM_HOME, $PATH, and/or $JAVA_HOME:
$ export GRAALVM_HOME="/Users/shaun/tmp/graalvm-ee-java17-22.3.0/Contents/Home"
$ export PATH="/Users/shaun/tmp/graalvm-ee-java17-22.3.0/Contents/Home/bin:$PATH"
$ export JAVA_HOME="/Users/shaun/tmp/graalvm-ee-java17-22.3.0/Contents/Home"

@melix, let's incorporate https://github.com/graalvm/graalvm-jdk-downloader in a followup PR?

@olyagpl olyagpl merged commit 93318bf into master Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants