https://github.com/zero88/java-gradle-template
Gradle template for java projects
https://github.com/zero88/java-gradle-template
Last synced: 4 months ago
JSON representation
Gradle template for java projects
- Host: GitHub
- URL: https://github.com/zero88/java-gradle-template
- Owner: zero88
- License: apache-2.0
- Created: 2023-03-20T08:48:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T01:51:10.000Z (almost 2 years ago)
- Last Synced: 2025-01-03T13:34:46.282Z (about 1 year ago)
- Language: Kotlin
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.adoc
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
= java-gradle-template
zero88
:repo: zero88/java-gradle-template
:artifact: io.github.zero88/java-gradle-template
:sonarKey: zero88_java-gradle-template
image:https://github.com/{repo}/actions/workflows/ci.yml/badge.svg[{repo},link=https://github.com/{repo}/actions/workflows/ci.yml]
image:https://img.shields.io/github/v/release/{repo}?sort=semver[GitHub release (latest SemVer)]
image:https://img.shields.io/nexus/r/{artifact}?server=https%3A%2F%2Foss.sonatype.org[Sonatype Nexus (Releases)]
image:https://img.shields.io/nexus/s/{artifact}?server=https%3A%2F%2Foss.sonatype.org[Sonatype Nexus (Snapshots)]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=ncloc[Lines of Code,link=https://sonarcloud.io/dashboard?id={sonarKey}]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=coverage[Coverage,link=https://sonarcloud.io/dashboard?id={sonarKey}]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=sqale_rating[Maintainability Rating,link=https://sonarcloud.io/dashboard?id={sonarKey}]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=reliability_rating[Reliability Rating,link=https://sonarcloud.io/dashboard?id={sonarKey}]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=security_rating[Security Rating,link=https://sonarcloud.io/dashboard?id={sonarKey}]
image:https://sonarcloud.io/api/project_badges/measure?project={sonarKey}&metric=alert_status[Quality Gate Status,link=https://sonarcloud.io/dashboard?id={sonarKey}]
Gradle template for opensource java projects
Please, correct some variables:
* link:./gradle.properties[gradle.properties]:
** `title=<title>`
** `description=<description>`
** `projectGroup`
** `projectLicense`
** `github.repo`
** `systemProp.sonar.organization=<sonar-org-key>`
** `systemProp.sonar.projectKey=<sonar-project-key>`
* link:./settings.gradle.kts#16[settings.gradle.kts]
** `projectName`
** Update subprojects structure
* link:./docs/build.gradle.kts#16[project(":docs")]
** Might update `val mainProject = extensions["BASE_NAME"] as String`
* link:.github/workflows/ci.yml[ci.yml]
** Replace env `MAIN_PROFILE: 'template'` to `MAIN_PROFILE: '<your_project_main_profile>'` (must not have blank)
* Add GitHub repository secrets for action
** `CI_GPG_PASSPHARSE`
** `CI_GPG_PRIVATE_KEY`
** `OSS_GITHUB_TOKEN`
** `OSS_SONARQUBE_TOKEN`
** `OSS_SONATYPE_PASSWORD`
** `OSS_SONATYPE_USER`
* Git branches:
** `docs/main`: To keep Antora component documentation.
** In case of host GitHub pages independent, create `gh-pages` and use https://github.com/zero88/shared-ghactions/blob/8ad1eb3773917b59db5d4cfba268ae17ec6121f4/.github/workflows/webdocs-standalone-publish.yml[shared-ghactions/.github/workflows/webdocs-standalone-publish.yml] in link:./.github/workflows/ci.yml[`ci.yml`].