From e5091d4d1c36c0c81c9f102a92d2c602c96578d8 Mon Sep 17 00:00:00 2001 From: Edward McFarlane <3036610+emcfarlane@users.noreply.github.com> Date: Fri, 24 Jan 2025 16:24:37 +0100 Subject: [PATCH] Link to migration docs Link to the migration docs for buf-action. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 14564ed..9d9e755 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-lint-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] enables you to [lint] Protobuf files with [Buf] in your GitHub Actions pipelines. If it detects violations of your configured [lint rules][lint.rules], it automatically creates inline @@ -78,6 +78,7 @@ steps: [action]: 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-lint-action [buf]: https://buf.build [buf-breaking]: https://github.com/marketplace/actions/buf-breaking [buf-push]: https://github.com/marketplace/actions/buf-push