changelog.yml

name: Changelog
on:
  # Trigger the workflow on pushes to only the 'hotfix' and 'release' branches
  push:
    branches:
      - hotfix/*
      - release/*
  # Trigger the workflow on manual dispatch
  workflow_dispatch:

jobs:
  changelog:
    name: Update Changelog
    runs-on: ubuntu-latest
    steps:

      # Check out current repository
      - name: Fetch Sources
        uses: actions/checkout@v4.2.2
        with:
          fetch-depth: 0

      # Set up Java environment for the next steps
      - name: Setup Java
        uses: actions/setup-java@v4.6.0
        with:
          distribution: zulu
          java-version: 17

      # Setup Gradle
      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@v4.2.2

      # Set environment variables
      - name: Export Properties
        id: properties
        shell: bash
        run: |
          PROPERTIES="$(./gradlew properties --console=plain -q)"
          VERSION="$(echo "$PROPERTIES" | grep "^version:" | cut -f2- -d ' ')"

          echo "version=$VERSION" >> $GITHUB_OUTPUT

      # Generate a changelog
      - name: Generate a changelog
        uses: orhun/git-cliff-action@v4.4.2
        id: git-cliff
        with:
          config: cliff.toml
          args: --verbose
        env:
          OUTPUT: CHANGELOG.md
          GIT_CLIFF_TAG: "${{ steps.properties.outputs.version }}"

      # Print the changelog
      - name: Print the changelog
        run: cat "${{ steps.git-cliff.outputs.changelog }}"

      # Create pull request
      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v7.0.6
        with:
          delete-branch: true
          branch-suffix: short-commit-hash
          commit-message: |
            docs(changelog): update the changelog file
            
            [skip ci]
          title: "docs(changelog): update the changelog file"
          body: "Current pull request contains patched `CHANGELOG.md` file."
          labels: documentation

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true