Skip to content

Commit

Permalink
Add notice for buf-action (#141)
Browse files Browse the repository at this point in the history
  • Loading branch information
emcfarlane authored Aug 1, 2024
1 parent c57b3d8 commit 35198da
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# `buf-breaking-action`

> [!NOTE]
> This action has been deprecated in favor of the [`buf-action`][buf-action] which combines the
> functionality of `buf-breaking-action` with the ability to run Buf commands in the same step. Please
> see the [`buf-action`][buf-action] documentation for more information.
This [Action][actions] enables you to run [breaking change detection][breaking] with
[Buf] in your GitHub Actions pipelines. If it detects breaking changes in a pull request, it
automatically creates inline comments under specific lines in your `.proto` files.
Expand Down Expand Up @@ -144,6 +149,7 @@ steps:
```

[actions]: https://docs.github.com/actions
[buf-action]: https://github.com/bufbuild/buf-action
[breaking]: https://docs.buf.build/breaking
[bsr]: https://docs.buf.build/bsr
[buf]: https://buf.build
Expand Down

0 comments on commit 35198da

Please sign in to comment.