news-fragment.yml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
---
name: CI

on:  # yamllint disable-line rule:truthy
  pull_request:
    types: [labeled, unlabeled, opened, reopened, synchronize]
permissions:
  contents: read
jobs:
  check-news-fragment:
    name: Check News Fragment
    runs-on: ubuntu-20.04
    if: "contains(github.event.pull_request.labels.*.name, 'airflow3.0:breaking')"

    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false
          # `towncrier check` runs `git diff --name-only origin/main...`, which
          # needs a non-shallow clone.
          fetch-depth: 0

      - name: Check news fragment existence
        env:
          BASE_REF: ${{ github.base_ref }}
        run: >
          python -m pip install --upgrade uv &&
          uv tool run towncrier check
          --dir .
          --config newsfragments/config.toml
          --compare-with origin/${BASE_REF}
          ||
          {
          printf "\033[1;33mMissing significant newsfragment for PR labeled with
          'airflow3.0:breaking'.\nCheck
          https://github.com/apache/airflow/blob/main/contributing-docs/16_contribution_workflow.rst
          for guidance.\033[m\n"
          &&
          false
          ; }

      - name: Check news fragment contains change types
        env:
          BASE_REF: ${{ github.base_ref }}
        run: >
          change_types=(
            'Dag changes'
            'Config changes'
            'API changes'
            'CLI changes'
            'Behaviour changes'
            'Plugin changes'
            'Dependency changes'
            'Code interface changes'
          )
          news_fragment_content=`git diff origin/${BASE_REF} newsfragments/*.significant.rst`

          for type in "${change_types[@]}"; do
            if [[ $news_fragment_content != *"$type"* ]]; then
              printf "\033[1;33mMissing change type '$type' in significant newsfragment for PR labeled with
              'airflow3.0:breaking'.\nCheck
              https://github.com/apache/airflow/blob/main/contributing-docs/16_contribution_workflow.rst
              for guidance.\033[m\n"
              exit 1
            fi
          done