README.adoc

java-gradle-template

Gradle template for opensource java projects

Please, correct some variables:

• gradle.properties:

  • title=<title>

  • description=<description>

  • projectGroup

  • projectLicense

  • github.repo

  • systemProp.sonar.organization=<sonar-org-key>

  • systemProp.sonar.projectKey=<sonar-project-key>

• settings.gradle.kts

  • projectName

  • Update subprojects structure

• project(":docs")

  • Might update val mainProject = extensions["BASE_NAME"] as String

• 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 shared-ghactions/.github/workflows/webdocs-standalone-publish.yml in ci.yml.