spring-guides / getting-started-macros

Collection of macros used to support getting started guides
14 stars 26 forks source link

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

Open robertmcnees opened 1 month ago

robertmcnees commented 1 month ago

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 commented 1 month ago

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.

Buzzardo commented 1 month ago

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 commented 3 weeks ago

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.