Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notice for buf-action #141

Merged
merged 1 commit into from
Aug 1, 2024
Merged

Add notice for buf-action #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
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
Loading