Skip to content

Commit

Permalink
Check breaking changes have a news fragment (apache#41443)
Browse files Browse the repository at this point in the history
  • Loading branch information
uranusjr committed Aug 14, 2024
1 parent 8653988 commit 509f15e
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/news-fragment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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]

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
run: >
pipx run towncrier check
--dir .
--config newsfragments/config.toml
--compare-with origin/${{ github.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
1 change: 1 addition & 0 deletions newsfragments/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
name = "Airflow"
filename = "RELEASE_NOTES.rst"
underlines = ["-", '^']
ignore = ["config.toml"]

[[tool.towncrier.type]]
directory = "significant"
Expand Down

0 comments on commit 509f15e

Please sign in to comment.