doc: add a PR template and improve the README #150
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Main | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: | |
| - v* | |
| pull_request: | |
| branches: | |
| - master | |
| jobs: | |
| check: | |
| name: Check & Publish | |
| runs-on: ubuntu-latest | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Caches | |
| - name: Gradle cache | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/.gradle/caches | |
| ~/.gradle/wrapper | |
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle*.properties') }} | |
| restore-keys: | | |
| ${{ runner.os }}-gradle- | |
| # JDK | |
| - name: Set up JDK | |
| uses: actions/setup-java@v3 | |
| with: | |
| distribution: 'temurin' | |
| java-version: 17 | |
| - name: Validate Gradle wrapper | |
| uses: gradle/wrapper-validation-action@v1 | |
| # Gradle check | |
| - name: Build with Gradle | |
| run: ./gradlew check | |
| # Publish | |
| - name: Publish package to Sonatype | |
| if: github.ref == 'refs/heads/master' | |
| env: | |
| ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }} | |
| ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }} | |
| SONATYPE_GPG_KEYID: ${{ secrets.SONATYPE_GPG_KEYID }} | |
| SONATYPE_GPG_PASSWORD: ${{ secrets.SONATYPE_GPG_PASSWORD }} | |
| SONATYPE_GPG_FILE: ${{ secrets.SONATYPE_GPG_FILE }} | |
| run: | | |
| echo "signing.keyId=${SONATYPE_GPG_KEYID}" > ~/.gradle/gradle.properties | |
| echo "signing.password=${SONATYPE_GPG_PASSWORD}" >> ~/.gradle/gradle.properties | |
| echo "signing.secretKeyRingFile=${HOME}/.gradle/secring.gpg" >> ~/.gradle/gradle.properties | |
| echo ${SONATYPE_GPG_FILE} | base64 -d > ~/.gradle/secring.gpg | |
| ./gradlew publishToSonatype | |
| # Release | |
| - name: Release package to Maven Central | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| env: | |
| ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }} | |
| ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }} | |
| SONATYPE_GPG_KEYID: ${{ secrets.SONATYPE_GPG_KEYID }} | |
| SONATYPE_GPG_PASSWORD: ${{ secrets.SONATYPE_GPG_PASSWORD }} | |
| SONATYPE_GPG_FILE: ${{ secrets.SONATYPE_GPG_FILE }} | |
| run: | | |
| echo "signing.keyId=${SONATYPE_GPG_KEYID}" > ~/.gradle/gradle.properties | |
| echo "signing.password=${SONATYPE_GPG_PASSWORD}" >> ~/.gradle/gradle.properties | |
| echo "signing.secretKeyRingFile=${HOME}/.gradle/secring.gpg" >> ~/.gradle/gradle.properties | |
| echo ${SONATYPE_GPG_FILE} | base64 -d > ~/.gradle/secring.gpg | |
| ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository | |
| # GitHub Release | |
| - name: Create GitHub release | |
| uses: "marvinpinto/action-automatic-releases@latest" | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| with: | |
| repo_token: "${{ secrets.GITHUB_TOKEN }}" | |
| prerelease: false | |
| files: | | |
| build/libs/*.jar | |
| # Slack | |
| - name: Slack notification | |
| uses: 8398a7/action-slack@v3 | |
| if: ${{ always() && env.SLACK_WEBHOOK_URL != 0 }} | |
| with: | |
| status: ${{ job.status }} | |
| job_name: Check & Publish | |
| fields: repo,message,commit,author,action,eventName,ref,workflow,job,took | |
| username: GitHub Actions | |
| icon_emoji: ':github-actions:' | |
| channel: 'C02DQ1A7JLR' | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} |