Skip to content

Commit

Permalink
Add symbol compatibility check to GitHub Actions checks
Browse files Browse the repository at this point in the history
This should be viewed as a non-mandatory check, as there are legitimate
cases we might want to break compatibility by removing symbol names.
However, such cases should be fairly uncommon.
  • Loading branch information
UsernameFodder committed Jan 4, 2024
1 parent 1a64bba commit 8bb14aa
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/check-symbol-compatibility.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Check Symbol Compatibility

on:
pull_request:
paths:
- 'symbols/**.yml'
branches:
- master

jobs:
compat-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Symbol compatibility check
# HEAD is $GITHUB_SHA, which is the PR merge commit; see:
# https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
# This means that HEAD^ should be the target branch head, i.e., master
run: tools/symcompat.py --warn HEAD^
# Ideally there would be an "allow-failure" option (continue-on-error isn't it); see:
# https://github.com/actions/runner/issues/2347

0 comments on commit 8bb14aa

Please sign in to comment.