[chore] fix up comment to match the function name #12063
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This GitHub action is used to compare API state snapshots of Main | |
# to Head of the PR in order to validate releases are not breaking | |
# backwards compatibility. | |
# | |
# This GitHub action will fail if there are incompatible changes. | |
# | |
name: "Inform Incompatible PRs" | |
on: | |
pull_request: | |
branches: | |
- main | |
permissions: | |
contents: read | |
jobs: | |
Check-Compatibility: | |
runs-on: macos-latest | |
env: | |
BASE_REF: ${{ github.base_ref }} | |
HEAD_REF: ${{ github.head_ref }} | |
steps: | |
- name: Checkout-Main | |
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
with: | |
ref: ${{ github.base_ref }} | |
path: ${{ github.base_ref }} | |
- name: Checkout-HEAD | |
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
with: | |
path: ${{ github.head_ref }} | |
- name: Setup Go | |
uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0 | |
with: | |
go-version: ~1.21.5 | |
# Generate apidiff states of Main | |
- name: Generate-States | |
run: | | |
cd $BASE_REF | |
make apidiff-build | |
# Compare apidiff states of Main with PR | |
- name: Compare-States | |
env: | |
CI: true | |
COMPARE_OPTS: -d "../${{ github.base_ref }}/internal/data/apidiff" | |
run: | | |
cd $HEAD_REF | |
make apidiff-compare | |
# Fail GitHub Action if there are incompatible changes | |
- name: Check-States | |
env: | |
CI: true | |
COMPARE_OPTS: -d "../${{ github.base_ref }}/internal/data/apidiff" -c | |
run: | | |
cd $HEAD_REF | |
make apidiff-compare |