Skip to content

Commit

Permalink
docs: improve gradle-new-java-library
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Davids <[email protected]>
  • Loading branch information
sdavids committed Feb 3, 2025
1 parent 9ef8160 commit 8f570a2
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The optional second parameter is the directory (`$PWD` if not given) the project

[NOTE]
====
A Git repository with `pre-commit` and `pre-push` https://git-scm.com/docs/githooks[hooks] will also be initialized for the project if `git` is installed.
A Git repository with `pre-commit` and `pre-push` https://git-scm.com/docs/githooks[hooks] will also be initialized for the project if `git` is installed.
This script uses https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work[Git commit signing] if `user.signingKey` is set in the https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key[global Git configuration].
====
Expand All @@ -22,20 +22,20 @@ You can https://docs.gradle.org/8.6/release-notes.html#simpler-source-package-ha
[,console]
----
printf 'org.gradle.buildinit.source.package=my.org' >> "${GRADLE_USER_HOME:=${HOME}}/gradle.properties"
printf 'org.gradle.buildinit.source.package=my.org' >>"${GRADLE_USER_HOME:=${HOME}}/gradle.properties"
----
If you want https://docs.gradle.org/8.7/release-notes.html#generating-concise-projects-with-gradle-init[no comments] to be generated add `org.gradle.buildinit.comments=false` in https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties[Gradle properties]:
[,console]
----
printf 'org.gradle.buildinit.comments=false' >> "${GRADLE_USER_HOME:=${HOME}}/gradle.properties"
printf 'org.gradle.buildinit.comments=false' >>"${GRADLE_USER_HOME:=${HOME}}/gradle.properties"
----
====

[TIP]
====
You might want to customize the defaults for the created `gradle.properties`, `.gitignore`, `.gitattributes`, or `.editorconfig`, e.g.:
You might want to customize the defaults for the created `.editorconfig`, `.gitattributes`, `.gitignore`, `gradle.properties`, `pre-commit` or `pre-push`, e.g.:
.zfunc/gradle_new_java_library
[,shell]
Expand Down

0 comments on commit 8f570a2

Please sign in to comment.