Skip to content

Commit

Permalink
Add notice for buf-action (#216)
Browse files Browse the repository at this point in the history
Updates the README to redirect users to use buf-action.
  • Loading branch information
emcfarlane committed Aug 1, 2024
1 parent aceb106 commit 3de295e
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-setup-action`

> [!NOTE]
> This action has been deprecated in favor of the [`buf-action`][buf-action] which combines the
> functionality of `buf-setup-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] installs the [`buf`][buf-cli] CLI in your GitHub Actions pipelines so that it can be
used by other Buf Actions:

Expand Down Expand Up @@ -169,6 +174,7 @@ steps:
```
[action]: 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-breaking]: https://github.com/marketplace/actions/buf-breaking
Expand Down

0 comments on commit 3de295e

Please sign in to comment.