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

Instructions for Native Compilation have a version number in text #17

Open
robertmcnees opened this issue May 28, 2024 · 3 comments
Open
Assignees

Comments

@robertmcnees
Copy link
Contributor

The file build_and_execute_guide.adoc contains instructions about how to include a Gradle plugin required for native compilation. In an effort to provide complete instructions to the user, a code snippet is provided that has a version number included.

Specifically the 0.9.28 version in the text below:


plugins {
id 'org.graalvm.buildtools.native' version '0.9.28'
...

Having the version number in text poses 2 problems I can see:

  1. The patch version (i.e. 0.9.28) is likely to get out of date quickly
  2. The major/minor version may not match the Boot version of the guide (i.e. Boot 3.3.x uses 0.10.x while Boot 3.2.x uses 0.9.x)
@robertmcnees
Copy link
Contributor Author

The Native Build Tools plugin versions can be found here.

The Spring Boot reference documentation addresses this issue by omitting the version number from the instructions.

You should check that your Gradle build contains a plugins block that includes org.graalvm.buildtools.native.

Given that the Getting Started Guides are designed to target new learners, I think it would be beneficial to provide the specific version number and text if possible.

@robertmcnees robertmcnees self-assigned this May 28, 2024
@Buzzardo
Copy link
Contributor

I would insert a caution to let the readers know that the version may change and to tell them how to look up the current version.

@mhalbritter
Copy link

When using Maven, the Spring Boot parent will take care of the version. Unfortunately for Gradle we can't manage the version. The current version of native build tools can be found in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants