diff --git a/README.md b/README.md index 27e1539..266c198 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ > [!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. +> see the [migration guide][buf-action-migration] 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 @@ -150,6 +150,7 @@ steps: [actions]: https://docs.github.com/actions [buf-action]: https://github.com/bufbuild/buf-action +[buf-action-migration]: https://github.com/bufbuild/buf-action/blob/main/MIGRATION.md#buf-breaking-action [breaking]: https://docs.buf.build/breaking [bsr]: https://docs.buf.build/bsr [buf]: https://buf.build