changelog_verifier.yml

name: "Changelog Verifier"
on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

jobs:
  # Enforces the update of a changelog file on every pull request
  verify-changelog:
    if: github.repository == 'opensearch-project/OpenSearch'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          ref: ${{ github.event.pull_request.head.sha }}
      - uses: dangoslen/changelog-enforcer@v3
        id: verify-changelog-3x
        with:
          skipLabels: "autocut, skip-changelog"
          changeLogPath: 'CHANGELOG-3.0.md'
        continue-on-error: true
      - uses: dangoslen/changelog-enforcer@v3
        id: verify-changelog
        with:
          skipLabels: "autocut, skip-changelog"
          changeLogPath: 'CHANGELOG.md'
        continue-on-error: true
      - run: |
          # The check was possibly skipped leading to success for both the jobs
          has_backport_label=${{ contains(join(github.event.pull_request.labels.*.name, ', '), 'backport')}}
          has_breaking_label=${{ contains(join(github.event.pull_request.labels.*.name, ', '), '>breaking')}}
          if [[ $has_breaking_label == true && $has_backport_label == true ]]; then
            echo "error: Please make sure that the PR does not have a backport label associated with it when making breaking changes"
            exit 1
          fi

          if [[ ${{ steps.verify-changelog-3x.outcome }} == 'success' && ${{ steps.verify-changelog.outcome }} == 'success' ]]; then
            exit 0
          fi

          if [[ ${{ steps.verify-changelog-3x.outcome }} == 'failure' && ${{ steps.verify-changelog.outcome }} == 'failure' ]]; then
            echo "error: Please ensure a changelog entry exists in CHANGELOG.md or CHANGELOG-3.0.md"
            exit 1
          fi

          # Concatenates the labels and checks if the string contains "backport"
          if [[ ${{ steps.verify-changelog.outcome }} == 'success' && $has_backport_label == false ]]; then
            echo "error: Please make sure that the PR has a backport label associated with it when making an entry to the CHANGELOG.md file"
            exit 1
          fi

          if [[ ${{ steps.verify-changelog-3x.outcome }} == 'success' && $has_backport_label == true ]]; then
            echo "error: Please make sure that the PR does not have a backport label associated with it when making an entry to the CHANGELOG-3.0.md file"
            exit 1
          fi