# Gradle ## Plugins 1. **Axion plugin** We are using Gradle's [axion-release](https://axion-release-plugin.readthedocs.io/en/latest/) plugin for release & version management. If current commit is tagged commit, project has a release version( i.e., 0.1.0).\ If there were any commits after last tag, project is in SNAPSHOT version( i.e., 0.1.1-SNAPSHOT). > `axion-release` follows the structure of git, only knows about tags on given branch. ## Usage > first time generating a new library project ```bash gradle init --type kotlin-library --dsl kotlin ``` ``` Options for all gradle commands: -D or --system-prop, -P or --project-prop, -m or --dry-run ``` Check Task Dependencies With a Dry Run with dryRun: -m or --dry-run i.e., `gradle publish -m` ### Version > display computed version ```bash gradle cV gradle currentVersion # to get version # as plain text export VERSION=$(gradle cV -q -Prelease.quiet) echo $VERSION ``` ### Verification ```bash gradle test gradle jacocoTestReport gradle jacocoTestCoverageVerification gradle sonarqube gradle check gradle sonarqube ``` ### Spotless tasks ```bash # spotlessCheck - Checks that sourcecode satisfies formatting steps. gradle spotlessCheck # spotlessApply - Applies code formatting steps to sourcecode in-place. gradle spotlessApply ``` ### Quarkus tasks ```bash # addExtension - Adds Quarkus extensions specified by the user to the project. gradle :apps:greeting-quarkus:addExtension --extensions="health,metrics,openapi" gradle :apps:greeting-quarkus:addExtension --extensions="hibernate-validator" gradle :apps:greeting-quarkus:addExtension --extensions="jdbc,agroal,non-exist-ent" # buildNative - Building a native image gradle :apps:greeting-quarkus:buildNative gradle :apps:greeting-quarkus:testNative # generateConfig - Generates an example config file # listExtensions - Lists the available quarkus extensions gradle :apps:greeting-quarkus:listExtensions # quarkusBuild - Quarkus builds a runner jar based on the build jar # quarkusDev - Development mode: enables hot deployment with background compilation gradle :apps:greeting-quarkus:quarkusDev -Dsuspend -Ddebug # quarkusTestConfig - Sets the necessary system properties for the Quarkus tests to run. ``` ### Build > build jar ```bash gradle build gradle build -x test # overriding version gradle build -Prelease.forceVersion=3.0.0 ``` ### Run ```bash gradle run ``` ### Release > bump git Tag and Push ```bash # dryRun gradle release -Prelease.dryRun # disable all checks for current release gradle release -Prelease.disableChecks -Prelease.dryRun # real release gradle release -Prelease.customUsername=sxc460 -Prelease.customPassword= # bump Minor Version : 0.1.0 -> 0.2.0 gradle markNextVersion -Prelease.incrementer=incrementMinor -Prelease.dryRun # in CI enveroment gradle release -Prelease.disableChecks -Prelease.pushTagsOnly -x test --profile # if you want to manually set version with Jenkins params gradle createRelease -Prelease.disableChecks -Prelease.versionIncrementer=incrementMajor -Prelease.dryRun gradle markNextVersion -Prelease.disableChecks -Prelease.incrementer=incrementMajor -Prelease.dryRun ``` ### Changelog > With every release, run `git-chglog` ```bash # first time git-chglog --init # on release branch, generate CHANGELOG.md and commit before merging back to develop & master. git-chglog -o CHANGELOG.md git-chglog -o CHANGELOG.md -next-tag 2.0.0 ``` ### Publish > publish after release ```bash gradle publish # skip tests in CI gradle publish -x test --profile gradle build publish -Prelease.forceSnapshot gradle build publish -Prelease.forceVersion=3.0.0 CI=true GITHUB_USER=xmlking GITHUB_TOKEN= gradle publish ``` ### Docker ```bash # Build an image tarball, # then you can load with `docker load --input build/jib-image.tar` gradle jibBuildTar # Build and publish docker image gradle jib # Build image locally useing your Docker daemon (on publish) gradle jibDockerBuild ``` #### local testing pull a remote image and locally use it as base image ```bash # pull base image first docker pull gcr.io/distroless/java:11 # use local docker image as base, build image only (on publish) gradle jibDockerBuild -PbaseDockerImage=docker://gcr.io/distroless/java:11 # you can run your local docker image docker run -it xmlking/micro-apps-demo:1.6.1-SNAPSHOT ``` ### Dependencies ```bash # Report dependencies gradle dependencyUpdates -Drevision=release -DoutputFormatter=json,xml # Update dependencies, `dependsOn dependencyUpdates` gradle useLatestVersions # This task will succeed if all available updates were successfully applied by useLatestVersions gradle useLatestVersions && gradle useLatestVersionsCheck ``` ### Gradle ```bash # upgrade gradlew # upgrade project gradle version gradle wrapper --gradle-version 6.2.2 --distribution-type all # gradle daemon status gradle --status gradle --stop # show dependencies gradle classifier:dependencies gradle classifier:dependencyInsight --dependency spring-messaging # refresh dependencies gradle build -x test --refresh-dependencies # display version gradle cV ``` ### Reference * * * --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://xmlking.gitbook.io/micro-apps/advanced/gradle.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.