Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 3.64 KB

HELP.md

File metadata and controls

100 lines (71 loc) · 3.64 KB
Raw

Getting Started

Rename your gradle project after cloning template project

Go to the unit test class 'io.github.astrapi69.InitialTemplateTest' and set your description for your repository in the disabled unit test method testRenameToConcreteProject. Then enable the unit test method testRenameToConcreteProject by comment or delete the annotation @Disabled and run it after. This will rename your gradle project. Now you can delete all unrelated files and test dependencies that you do not need.

Also delete the section '# Template from this project' in the README.md.

If you are use intellij ide than you can add the new gradle run configurations to git and delete the run configurations for the unit test and the unit test class itself.

Setting Secrets

When you clone from this repository you have to consider to set the secrets for the sonatype username and password.

In the project gradle.properties we have two properties: (Note that the project gradle.properties is public and can see everyone)

projectRepositoriesUserNameKey=ossrhUsername
projectRepositoriesPasswordKey=ossrhPassword

The value of this properties keys are properties keys from your local file '/.gradle/gradle.properties' were you keep your username and your secret password that have to be kept secret. So in your local file '/.gradle/gradle.properties' looks for instance like this:

ossrhUsername=ReplaceThisWithYourSonatypeUsername
ossrhPassword=ReplaceThisWithYourSecretSonatypePassword

(Note that you have to replace 'ReplaceThisWithYourSonatypeUsername' and 'ReplaceThisWithYourSecretSonatypePassword' with your corresponding username and password)

Your local build builds now successful. But the build in your actions fail because you do not have set the secrets in your repository.

For setting secrets for your repository you can consider the following sections:

Beware in step where you set the name you have to set for 'ossrhUsername' the value: 'ossrhUsername' and not 'OSSRHUSERNAME' The same procedure for the secret 'ossrhPassword'

Note that for organizations you only need to set the secrets once.

The following source code is the complete gradle.yml in the repository folder '.github/workflows'

name: Java CI with Gradle

on:
  push:
    branches: [ develop ]
  pull_request:
    branches: [ develop ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'
    - name: Build with Gradle
      uses: gradle/gradle-build-action@v2.8.0
      with:
        arguments: build
      env:
        ossrhUsername: ${{secrets.OSSRHUSERNAME}}
        ossrhPassword: ${{secrets.OSSRHPASSWORD}}
    - uses: codecov/codecov-action@v3
      with:
        token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos

So you have to set two secrets: OSSRHUSERNAME, OSSRHPASSWORD. And one optional if your repository is not public CODECOV_TOKEN where you save your codecov token value.

Reference Documentation

For further reference, please consider the following sections:

Additional Links

These additional references should also help you: