doc(ci): add comment to explain HEAD~1

ExocoreNetwork · Mar 4, 2024 · 667c3d2 · 667c3d2
1 parent 7b9871a
commit 667c3d2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/.github/workflows/proto.yml b/.github/workflows/proto.yml
@@ -41,4 +41,8 @@ jobs:
       - uses: bufbuild/buf-breaking-action@v1
         with:
           input: "proto"
+          # previously, this ran on ref=HEAD~1, which is incorrect as it can
+          # only be used to compare within a branch. it is designed to run
+          # on a PR, so it must compare the HEAD of the base branch against
+          # the PR branch.
           against: "https://github.com/${{ github.repository }}.git#branch=${{ github.event.pull_request.base.ref }},subdir=proto"