From 2677d45fb0d722bb3b2877d980997ae763fdb790 Mon Sep 17 00:00:00 2001 From: Edward McFarlane Date: Thu, 1 Aug 2024 17:20:03 +0200 Subject: [PATCH 1/2] Add notice for buf-action --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e10c0fa..7c87590 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # `buf-setup-action` -This [Action] installs the [`buf`][buf-cli] CLI in your GitHub Actions pipelines so that it can be -used by other Buf Actions: +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. -* [`buf-breaking-action`][buf-breaking] -* [`buf-lint-action`][buf-lint] -* [`buf-push-action`][buf-push] - -After `buf-setup-action` is run, the `buf` command is available to other Actions in the pipeline's -`PATH`. You can also use the `buf` command directly inside of workflow steps. +To replace `buf-setup-action` with `buf-action`, you can use the following configuration: +``` +steps: + - uses: actions/checkout@v4 + - uses: bufbuild/buf-action@v1 + with: + # Setup only installs the `buf` CLI, it does not run any commands. + setup_only: true +``` ## Usage @@ -169,6 +173,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 From c0e509d94a4aa4b9bd70515f38894eb3df8b7c9c Mon Sep 17 00:00:00 2001 From: Edward McFarlane Date: Thu, 1 Aug 2024 19:49:25 +0200 Subject: [PATCH 2/2] Use note --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7c87590..8574025 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ # `buf-setup-action` -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. +> [!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. -To replace `buf-setup-action` with `buf-action`, you can use the following configuration: -``` -steps: - - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v1 - with: - # Setup only installs the `buf` CLI, it does not run any commands. - setup_only: true -``` +This [Action] installs the [`buf`][buf-cli] CLI in your GitHub Actions pipelines so that it can be +used by other Buf Actions: + +* [`buf-breaking-action`][buf-breaking] +* [`buf-lint-action`][buf-lint] +* [`buf-push-action`][buf-push] + +After `buf-setup-action` is run, the `buf` command is available to other Actions in the pipeline's +`PATH`. You can also use the `buf` command directly inside of workflow steps. ## Usage