Skip to content

Commit 5ba9512

Browse files
authored
Prepare for v0.3.0 (#57)
1 parent 4b64761 commit 5ba9512

File tree

16 files changed

+28
-28
lines changed

16 files changed

+28
-28
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
runs-on: ubuntu-latest
3737
steps:
3838
- uses: actions/checkout@v4
39-
- uses: bufbuild/buf-action@v0.2
39+
- uses: bufbuild/buf-action@v0.3
4040
with:
4141
token: ${{ secrets.BUF_TOKEN }}
4242
```
@@ -56,7 +56,7 @@ To customize the behavior of the action, you can set the following parameters in
5656
Add these parameters under the `with` section of the `uses` step in the workflow file.
5757

5858
```yaml
59-
- uses: bufbuild/buf-action@v0.2
59+
- uses: bufbuild/buf-action@v0.3
6060
with:
6161
...
6262
```
@@ -101,7 +101,7 @@ To disable parts of the workflow, each step corresponds to a boolean flag in the
101101
For example to disable formatting set the parameter `format` to `false`:
102102

103103
```yaml
104-
- uses: bufbuild/buf-action@v0.2
104+
- uses: bufbuild/buf-action@v0.3
105105
with:
106106
format: false
107107
```
@@ -113,7 +113,7 @@ See [action.yml](action.yml) for all available parameters.
113113
For reproducible builds, you can pin to an explicit version of `buf` by setting `version`.
114114

115115
```yaml
116-
- uses: bufbuild/buf-action@v0.2
116+
- uses: bufbuild/buf-action@v0.3
117117
with:
118118
version: 1.35.0
119119
```
@@ -133,7 +133,7 @@ To authenticate with the BSR, set the API token as the parameter `token`.
133133
Generate a token from the [BSR UI](https://buf.build/docs/bsr/authentication#create-an-api-token) and add it to the [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets).
134134

135135
```yaml
136-
- uses: bufbuild/buf-action@v0.2
136+
- uses: bufbuild/buf-action@v0.3
137137
with:
138138
token: ${{ secrets.BUF_TOKEN }}
139139
```
@@ -163,7 +163,7 @@ jobs:
163163
runs-on: ubuntu-latest
164164
steps:
165165
- uses: actions/checkout@v4
166-
- uses: bufbuild/buf-action@v0.2
166+
- uses: bufbuild/buf-action@v0.3
167167
with:
168168
token: ${{ secrets.BUF_TOKEN }}
169169
+ pr_comment: false
@@ -175,7 +175,7 @@ To run the action for parameters not declared at the root of the repository,
175175
set the parameter `input` to the directory of your `buf.yaml` file.
176176

177177
```yaml
178-
- uses: bufbuild/buf-action@v0.2
178+
- uses: bufbuild/buf-action@v0.3
179179
with:
180180
input: <path/to/module>
181181
```
@@ -184,7 +184,7 @@ Breaking change detection by default will use the `input` value as a subdirector
184184
To customize this behavior, set the parameter `breaking_against` to the desired input.
185185

186186
```yaml
187-
- uses: bufbuild/buf-action@v0.2
187+
- uses: bufbuild/buf-action@v0.3
188188
with:
189189
input: <path/to/module>
190190
breaking_against: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.base.sha }},subdir=<path/to/module>
@@ -201,7 +201,7 @@ and then set the value of `breaking_against` to the path of the base.
201201
with:
202202
path: base
203203
ref: ${{ github.event.pull_request.base.sha }}
204-
- uses: bufbuild/buf-action@v0.2
204+
- uses: bufbuild/buf-action@v0.3
205205
with:
206206
input: head/<path/to/module>
207207
breaking_against: base/<path/to/module>
@@ -216,7 +216,7 @@ This will install `buf` and optionally login to the schema registry but no addit
216216
Subsequent steps will have `buf` available in their $PATH and can invoke `buf` directly.
217217

218218
```yaml
219-
- uses: bufbuild/buf-action@v0.2
219+
- uses: bufbuild/buf-action@v0.3
220220
with:
221221
setup_only: true
222222
- run: buf build --error-format github-actions
@@ -230,7 +230,7 @@ To trigger steps on different events use the GitHub action context to deduce the
230230
For example to enable formatting checks on both pull requests and push create an expression for the parameter `format`:
231231

232232
```yaml
233-
- uses: bufbuild/buf-action@v0.2
233+
- uses: bufbuild/buf-action@v0.3
234234
with:
235235
format: ${{ contains(fromJSON('["push", "pull_request"]'), github.event_name) }}
236236
```
@@ -243,7 +243,7 @@ To conditionally run checks based on user input, use the GitHub action context t
243243
For example to disable breaking change detection on commits, create an expression on the parameter `breaking` to check the contents of the commit message:
244244

245245
```yaml
246-
- uses: bufbuild/buf-action@v0.2
246+
- uses: bufbuild/buf-action@v0.3
247247
with:
248248
breaking: |
249249
contains(fromJSON('["push", "pull_request"]'), github.event_name) &&

examples/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
- uses: actions/checkout@v4
16-
- uses: bufbuild/buf-action@v0.2
16+
- uses: bufbuild/buf-action@v0.3
1717
with:
1818
token: ${{ secrets.BUF_TOKEN }}

examples/disable-skip/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616
steps:
1717
- uses: actions/checkout@v4
18-
- uses: bufbuild/buf-action@v0.2
18+
- uses: bufbuild/buf-action@v0.3
1919
with:
2020
token: ${{ secrets.BUF_TOKEN }}
2121
breaking: ${{ github.event_name == 'pull_request' }}

examples/only-checks/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v4
14-
- uses: bufbuild/buf-action@v0.2
14+
- uses: bufbuild/buf-action@v0.3

examples/only-setup-defaults/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- uses: actions/checkout@v4
17-
- uses: bufbuild/buf-action@v0.2
17+
- uses: bufbuild/buf-action@v0.3
1818
with:
1919
setup_only: true
2020
- env:

examples/only-setup/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v4
13-
- uses: bufbuild/buf-action@v0.2
13+
- uses: bufbuild/buf-action@v0.3
1414
with:
1515
# Add the parameter token as a secret in your repository settings
1616
# to authenticate with the Buf Schema Registry.

examples/only-sync/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v4
13-
- uses: bufbuild/buf-action@v0.2
13+
- uses: bufbuild/buf-action@v0.3
1414
with:
1515
token: ${{ secrets.BUF_TOKEN }}

examples/push-on-changes/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ jobs:
1919
runs-on: ubuntu-latest
2020
steps:
2121
- uses: actions/checkout@v4
22-
- uses: bufbuild/buf-action@v0.2
22+
- uses: bufbuild/buf-action@v0.3
2323
with:
2424
token: ${{ secrets.BUF_TOKEN }}

examples/skip-on-commits/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v4
13-
- uses: bufbuild/buf-action@v0.2
13+
- uses: bufbuild/buf-action@v0.3
1414
with:
1515
token: ${{ secrets.BUF_TOKEN }}
1616
lint: |

examples/skip-on-labels/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- uses: actions/checkout@v4
15-
- uses: bufbuild/buf-action@v0.2
15+
- uses: bufbuild/buf-action@v0.3
1616
with:
1717
token: ${{ secrets.BUF_TOKEN }}
1818
lint: |

examples/validate-push/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v4
13-
- uses: bufbuild/buf-action@v0.2
13+
- uses: bufbuild/buf-action@v0.3
1414
with:
1515
# The token paramater is required to authenticate with the Buf Schema Registry.
1616
token: ${{ secrets.BUF_TOKEN }}

examples/version-env/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
steps:
1313
- uses: actions/checkout@v4
14-
- uses: bufbuild/buf-action@v0.2
14+
- uses: bufbuild/buf-action@v0.3
1515
with:
1616
setup_only: true
1717
- run: buf version

examples/version-input/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
12-
- uses: bufbuild/buf-action@v0.2
12+
- uses: bufbuild/buf-action@v0.3
1313
with:
1414
setup_only: true
1515
version: 1.35.0

examples/version-latest/buf-ci.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
12-
- uses: bufbuild/buf-action@v0.2
12+
- uses: bufbuild/buf-action@v0.3
1313
with:
1414
setup_only: true
1515
- run: buf version

package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "buf-action",
3-
"version": "0.2.2",
3+
"version": "0.3.0",
44
"description": "GitHub Action for buf",
55
"main": "src/main.ts",
66
"scripts": {

0 commit comments

Comments
 (0)