Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: bufbuild/buf-setup-action
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.35.1
Choose a base ref
...
head repository: bufbuild/buf-setup-action
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.36.0
Choose a head ref
  • 2 commits
  • 2 files changed
  • 3 contributors

Commits on Aug 1, 2024

  1. Add notice for buf-action (#216)

    Updates the README to redirect users to use buf-action.
    emcfarlane authored Aug 1, 2024
    Copy the full SHA
    3de295e View commit details

Commits on Aug 6, 2024

  1. Release v1.36.0 (#218)

    Release prepared for 1.36.0
    
    Co-authored-by: oliversun9 <oliversun9@users.noreply.github.com>
    app-token-buf-setup-action[bot] and oliversun9 authored Aug 6, 2024
    Copy the full SHA
    bdb5940 View commit details
Showing with 20 additions and 14 deletions.
  1. +19 −13 README.md
  2. +1 −1 action.yml
32 changes: 19 additions & 13 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:

@@ -19,7 +24,7 @@ steps:
# Run `git checkout`
- uses: actions/checkout@v2
# Install the `buf` CLI
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
# Ensure that `buf` is installed
- run: buf --version
```
@@ -32,7 +37,7 @@ You can configure `buf-setup-action` with these parameters:

| Parameter | Description | Default |
|:---------------|:---------------------------------------------------|:-------------------|
| `version` | The version of the [`buf` CLI][buf-cli] to install | [`v1.35.1`][version] |
| `version` | The version of the [`buf` CLI][buf-cli] to install | [`v1.36.0`][version] |
| `github_token` | The GitHub token to use when making API requests | |
| `buf_user` | The username to use for logging into Buf Schema registry. | |
| `buf_api_token` | The API token to use for logging into Buf Schema registry. | |
@@ -47,7 +52,7 @@ If `version` is unspecified, the latest version of `buf` is installed:
steps:
- uses: actions/checkout@v2
# Installs latest
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
- run: buf --version
```

@@ -56,11 +61,11 @@ Use the `version` parameter to pin to a specific version:
```yaml
steps:
- uses: actions/checkout@v2
# Installs version 1.35.1
- uses: bufbuild/buf-setup-action@v1.35.1
# Installs version 1.36.0
- uses: bufbuild/buf-setup-action@v1.36.0
with:
version: 1.35.1
# Should output 1.35.1
version: 1.36.0
# Should output 1.36.0
- run: buf --version
```

@@ -70,7 +75,7 @@ recommended:
```yaml
steps:
- uses: actions/checkout@v2
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
with:
version: latest
- run: buf --version
@@ -83,7 +88,7 @@ This may prevent rate limit issues when running on GitHub hosted runners:

```yaml
steps:
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
with:
github_token: ${{ github.token }}
```
@@ -95,7 +100,7 @@ you must still pass the token to the action:

```yaml
steps:
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
@@ -106,7 +111,7 @@ If you are using Private [Remote Packages](https://docs.buf.build/bsr/remote-pac

```yaml
steps:
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
with:
buf_user: ${{ secrets.buf_user }}
buf_api_token: ${{ secrets.buf_api_token }}
@@ -163,12 +168,13 @@ steps:
# Run `git checkout`
- uses: actions/checkout@v2
# Install the `buf` CLI
- uses: bufbuild/buf-setup-action@v1.35.1
- uses: bufbuild/buf-setup-action@v1.36.0
# Install `protoc`
- uses: arduino/setup-protoc@v1
```
[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
@@ -179,4 +185,4 @@ steps:
[compiler]: https://docs.buf.build/build/internal-compiler
[protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
[setup-protoc]: https://github.com/marketplace/actions/setup-protoc
[version]: https://github.com/bufbuild/buf/releases/tag/v1.35.1
[version]: https://github.com/bufbuild/buf/releases/tag/v1.36.0
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ inputs:
version:
description: The version of buf to set up.
required: false
default: '1.35.1'
default: '1.36.0'
github_token:
description: The GitHub token to use when making API requests.
required: false