Browse Source

Merge pull request #45677 from ngocnhan-tran1996

* pr/45677:
  Document use of git-commit-id-maven-plugin consistently

Closes gh-45677
3.3.x
Stéphane Nicoll 8 months ago
parent
commit
f0d05f0b86
  1. 1
      buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
  2. 2
      spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/build.adoc
  3. 2
      spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/using.adoc

1
buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties

@ -9,6 +9,7 @@ url-ant-docs=https://ant.apache.org/manual @@ -9,6 +9,7 @@ url-ant-docs=https://ant.apache.org/manual
url-buildpacks-docs=https://buildpacks.io/docs
url-cyclonedx-docs-gradle-plugin=https://github.com/CycloneDX/cyclonedx-gradle-plugin
url-cyclonedx-docs-maven-plugin=https://github.com/CycloneDX/cyclonedx-maven-plugin
url-git-commit-id-maven-plugin=https://github.com/git-commit-id/git-commit-id-maven-plugin
url-download-liberica-nik=https://bell-sw.com/pages/downloads/native-image-kit/#/nik-22-17
url-dynatrace-docs=https://docs.dynatrace.com/docs
url-dynatrace-docs-shortlink={url-dynatrace-docs}/shortlink

2
spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/build.adoc

@ -56,7 +56,7 @@ TIP: See the xref:gradle-plugin:integrating-with-actuator.adoc[Spring Boot Gradl @@ -56,7 +56,7 @@ TIP: See the xref:gradle-plugin:integrating-with-actuator.adoc[Spring Boot Gradl
Both Maven and Gradle allow generating a `git.properties` file containing information about the state of your `git` source code repository when the project was built.
For Maven users, the `spring-boot-starter-parent` POM includes a pre-configured plugin to generate a `git.properties` file.
To use it, add the following declaration for the https://github.com/git-commit-id/git-commit-id-maven-plugin[`Git Commit Id Plugin`] to your POM:
To use it, add the following declaration for the {url-git-commit-id-maven-plugin}[`Git Commit Id Plugin`] to your POM:
[source,xml]
----

2
spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/using.adoc

@ -12,7 +12,7 @@ This dependency management lets you omit `<version>` tags for those dependencies @@ -12,7 +12,7 @@ This dependency management lets you omit `<version>` tags for those dependencies
* An execution of the xref:maven-plugin:packaging.adoc#packaging.repackage-goal[`repackage` goal] with a `repackage` execution id.
* A `native` profile that configures the build to be able to generate a Native image.
* Sensible https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html[resource filtering].
* Sensible plugin configuration (https://github.com/ktoso/maven-git-commit-id-plugin[Git commit ID], and https://maven.apache.org/plugins/maven-shade-plugin/[shade]).
* Sensible plugin configuration ({url-git-commit-id-maven-plugin}[`Git Commit Id Plugin`], and https://maven.apache.org/plugins/maven-shade-plugin/[shade]).
* Sensible resource filtering for `application.properties` and `application.yml` including profile-specific files (for example, `application-dev.properties` and `application-dev.yml`)
NOTE: Since the `application.properties` and `application.yml` files accept Spring style placeholders (`${...}`), the Maven filtering is changed to use `@..@` placeholders.

Loading…
Cancel
Save