spring-guides / getting-started-macros Goto Github PK

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)

Most guides have a "Run the service" section that duplicates the end of what's in the "Build an executable JAR" section just before.

It might be helpful to complete beginners to specify the build.gradle file goes in the root directory of the solution.

This isn't really necessary if the user understands gradle, but some beginner guides (such as rest-service) don't mention this anywhere else.