bufbuild · Apr 11, 2023 · Apr 20, 2023 · May 5, 2023
Showing with 42 additions and 18 deletions.

+31 −12 README.md

+5 −1 action.yml

+1 −1 dist/main.js

+3 −3 dist/main.js.map

+2 −1 src/run.ts
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ steps:
   # Run `git checkout`
   - uses: actions/checkout@v2
   # Install the `buf` CLI
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
   # Ensure that `buf` is installed
   - run: buf --version
 ```
@@ -32,10 +32,11 @@ You can configure `buf-setup-action` with these parameters:
 
 | Parameter      | Description                                        | Default            |
 |:---------------|:---------------------------------------------------|:-------------------|
-| `version`      | The version of the [`buf` CLI][buf-cli] to install | [`v1.17.0`][version] |
+| `version`      | The version of the [`buf` CLI][buf-cli] to install | [`v1.18.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.                                                                                                            |                    |
+| `buf_domain`    | The domain of the Buf Schema Registry to login to.     | buf.build |
 
 > These parameters are derived from [`action.yml`](./action.yml). <br>
 #### Version
@@ -46,7 +47,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.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
   - run: buf --version
 ```
 
@@ -55,11 +56,11 @@ Use the `version` parameter to pin to a specific version:
 ```yaml
 steps:
   - uses: actions/checkout@v2
-  # Installs version 1.17.0
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  # Installs version 1.18.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
     with:
-      version: 1.17.0
-  # Should output 1.17.0
+      version: 1.18.0
+  # Should output 1.18.0
   - run: buf --version
 ```
 
@@ -69,7 +70,7 @@ recommended:
 ```yaml
 steps:
   - uses: actions/checkout@v2
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
     with:
       version: latest
   - run: buf --version
@@ -82,18 +83,30 @@ This may prevent rate limit issues when running on GitHub hosted runners:
 
 ```yaml
 steps:
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
     with:
       github_token: ${{ github.token }}
 ```
 
+The token will need the `contents:read` permission to be able to read the latest release and tag of buf. This permission
+is granted [by default](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)
+to the `GITHUB_TOKEN` that is created for every workflow run of a Github Action, so it is not necessary to explicitly specify the permission. However,
+you must still pass the token to the action:
+
+```yaml
+steps:
+  - uses: bufbuild/buf-setup-action@v1.18.0
+    with:
+      github_token: ${{ secrets.GITHUB_TOKEN }}
+```
+
 #### Buf username and Buf API token
 
 If you are using Private [Remote Packages](https://docs.buf.build/bsr/remote-packages/overview) you may need to authenticate the entire system to successfully communicate with the [Buf Schema Registry][bsr]. To achieve this, supply both `buf_user` and `buf_api_token`. This will add your auth credentials to the `.netrc` and allow you to access the BSR from anything in your `PATH`. 
 
 ```yaml
 steps:
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
     with:
       buf_user: ${{ secrets.buf_user }}
       buf_api_token: ${{ secrets.buf_api_token }}
@@ -117,6 +130,12 @@ Note that this only authenticate you with the `buf` cli. You cannot access your
 packages in BSR. If you need to access your private remote packages, supply the username and Buf
 API Token [as parameters](#buf-username-and-buf-api-token). 
 
+#### Buf domain
+
+If you are working with a private BSR then you can set the `buf_domain` input to the domain of
+your instance. Please ensure that you are using a token created on your instance (e.g. `https://buf.example.com/settings/user`) and not from the public BSR at `https://buf.build`.
+
+
 #### Installing `protoc`
 
 In most cases, you _don't_ need to install [`protoc`][protoc] for Buf's GitHub Actions, but some
@@ -144,7 +163,7 @@ steps:
   # Run `git checkout`
   - uses: actions/checkout@v2
   # Install the `buf` CLI
-  - uses: bufbuild/buf-setup-action@v1.17.0
+  - uses: bufbuild/buf-setup-action@v1.18.0
   # Install `protoc`
   - uses: arduino/setup-protoc@v1
 ```
@@ -160,4 +179,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.17.0
+[version]: https://github.com/bufbuild/buf/releases/tag/v1.18.0
diff --git a/action.yml b/action.yml
@@ -8,7 +8,7 @@ inputs:
   version:
     description: The version of buf to set up.
     required: false
-    default: '1.17.0'
+    default: '1.18.0'
   github_token:
     description: The GitHub token to use when making API requests.
     required: false
@@ -18,6 +18,10 @@ inputs:
   buf_api_token:
     description: The API token to use for logging into Buf Schema registry.
     required: false
+  buf_domain:
+    description: The domain of the Buf Schema Registry to login to.
+    required: false
+    default: 'buf.build'
 runs:
   using: "node16"
   main: "./dist/main.js"
diff --git a/dist/main.js b/dist/main.js