From abbad6310daffaf9471b28f9ed3a06856204abb5 Mon Sep 17 00:00:00 2001
From: Edward McFarlane <emcfarlane@buf.build>
Date: Fri, 30 Aug 2024 09:38:44 -0400
Subject: [PATCH] Add example for checks to guard push

---
 examples/check-before-push/buf-ci.yaml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 examples/check-before-push/buf-ci.yaml

diff --git a/examples/check-before-push/buf-ci.yaml b/examples/check-before-push/buf-ci.yaml
new file mode 100644
index 0000000..8af052e
--- /dev/null
+++ b/examples/check-before-push/buf-ci.yaml
@@ -0,0 +1,22 @@
+# This workflow runs checks before pushing to the BSR.
+name: Buf CI
+on:
+  push:
+  delete:
+permissions:
+  contents: read
+jobs:
+  buf:      
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bufbuild/buf-action@v1
+        with:
+          token: ${{ secrets.BUF_TOKEN }}
+          lint: ${{ github.event_name == 'push' }}
+          format: ${{ github.event_name == 'push' }}
+          breaking: ${{ github.event_name == 'push' && !contains(github.event.head_commit.message, 'buf skip breaking') }}
+          # Specify the branch to compare against for breaking change detection.
+          # The default for push is to compare to the commit before. We want to
+          # compare against the main branch for a GitHub flow style workflow.
+          breaking_against: .git#branch=main