Skip to content

Commit e08102e

Browse files
emcfarlaneemcfarlane
authored
Prepare for v1.0.0 (#58)
This is `buf-action`'s first release! It does not contain any user-facing changes from v0.3.0.
1 parent 5ba9512 commit e08102e

File tree

16 files changed

+28
-31
lines changed

16 files changed

+28
-31
lines changed

‎README.md

+12-15
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
[![ci](https://github.com/bufbuild/buf-action/actions/workflows/ci.yaml/badge.svg?branch=main)][ci]
66
[![slack](https://img.shields.io/badge/slack-buf-%23e01563)][slack]
77

8-
> [!CAUTION]
9-
> This is in alpha and is under development, stay tuned!
10-
118
This GitHub action makes it easy to run [`buf`][buf] within a workflow to check for
129
[build](https://buf.build/docs/reference/cli/buf/build),
1310
[lint](https://buf.build/docs/lint/overview),
@@ -36,7 +33,7 @@ jobs:
3633
runs-on: ubuntu-latest
3734
steps:
3835
- uses: actions/checkout@v4
39-
- uses: bufbuild/buf-action@v0.3
36+
- uses: bufbuild/buf-action@v1
4037
with:
4138
token: ${{ secrets.BUF_TOKEN }}
4239
```
@@ -56,7 +53,7 @@ To customize the behavior of the action, you can set the following parameters in
5653
Add these parameters under the `with` section of the `uses` step in the workflow file.
5754

5855
```yaml
59-
- uses: bufbuild/buf-action@v0.3
56+
- uses: bufbuild/buf-action@v1
6057
with:
6158
...
6259
```
@@ -101,7 +98,7 @@ To disable parts of the workflow, each step corresponds to a boolean flag in the
10198
For example to disable formatting set the parameter `format` to `false`:
10299

103100
```yaml
104-
- uses: bufbuild/buf-action@v0.3
101+
- uses: bufbuild/buf-action@v1
105102
with:
106103
format: false
107104
```
@@ -113,7 +110,7 @@ See [action.yml](action.yml) for all available parameters.
113110
For reproducible builds, you can pin to an explicit version of `buf` by setting `version`.
114111

115112
```yaml
116-
- uses: bufbuild/buf-action@v0.3
113+
- uses: bufbuild/buf-action@v1
117114
with:
118115
version: 1.35.0
119116
```
@@ -133,7 +130,7 @@ To authenticate with the BSR, set the API token as the parameter `token`.
133130
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).
134131

135132
```yaml
136-
- uses: bufbuild/buf-action@v0.3
133+
- uses: bufbuild/buf-action@v1
137134
with:
138135
token: ${{ secrets.BUF_TOKEN }}
139136
```
@@ -163,7 +160,7 @@ jobs:
163160
runs-on: ubuntu-latest
164161
steps:
165162
- uses: actions/checkout@v4
166-
- uses: bufbuild/buf-action@v0.3
163+
- uses: bufbuild/buf-action@v1
167164
with:
168165
token: ${{ secrets.BUF_TOKEN }}
169166
+ pr_comment: false
@@ -175,7 +172,7 @@ To run the action for parameters not declared at the root of the repository,
175172
set the parameter `input` to the directory of your `buf.yaml` file.
176173

177174
```yaml
178-
- uses: bufbuild/buf-action@v0.3
175+
- uses: bufbuild/buf-action@v1
179176
with:
180177
input: <path/to/module>
181178
```
@@ -184,7 +181,7 @@ Breaking change detection by default will use the `input` value as a subdirector
184181
To customize this behavior, set the parameter `breaking_against` to the desired input.
185182

186183
```yaml
187-
- uses: bufbuild/buf-action@v0.3
184+
- uses: bufbuild/buf-action@v1
188185
with:
189186
input: <path/to/module>
190187
breaking_against: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.base.sha }},subdir=<path/to/module>
@@ -201,7 +198,7 @@ and then set the value of `breaking_against` to the path of the base.
201198
with:
202199
path: base
203200
ref: ${{ github.event.pull_request.base.sha }}
204-
- uses: bufbuild/buf-action@v0.3
201+
- uses: bufbuild/buf-action@v1
205202
with:
206203
input: head/<path/to/module>
207204
breaking_against: base/<path/to/module>
@@ -216,7 +213,7 @@ This will install `buf` and optionally login to the schema registry but no addit
216213
Subsequent steps will have `buf` available in their $PATH and can invoke `buf` directly.
217214

218215
```yaml
219-
- uses: bufbuild/buf-action@v0.3
216+
- uses: bufbuild/buf-action@v1
220217
with:
221218
setup_only: true
222219
- run: buf build --error-format github-actions
@@ -230,7 +227,7 @@ To trigger steps on different events use the GitHub action context to deduce the
230227
For example to enable formatting checks on both pull requests and push create an expression for the parameter `format`:
231228

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

245242
```yaml
246-
- uses: bufbuild/buf-action@v0.3
243+
- uses: bufbuild/buf-action@v1
247244
with:
248245
breaking: |
249246
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.3
16+
- uses: bufbuild/buf-action@v1
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.3
18+
- uses: bufbuild/buf-action@v1
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.3
14+
- uses: bufbuild/buf-action@v1

‎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.3
17+
- uses: bufbuild/buf-action@v1
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.3
13+
- uses: bufbuild/buf-action@v1
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.3
13+
- uses: bufbuild/buf-action@v1
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.3
22+
- uses: bufbuild/buf-action@v1
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.3
13+
- uses: bufbuild/buf-action@v1
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.3
15+
- uses: bufbuild/buf-action@v1
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.3
13+
- uses: bufbuild/buf-action@v1
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.3
14+
- uses: bufbuild/buf-action@v1
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.3
12+
- uses: bufbuild/buf-action@v1
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.3
12+
- uses: bufbuild/buf-action@v1
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.3.0",
3+
"version": "1.0.0",
44
"description": "GitHub Action for buf",
55
"main": "src/main.ts",
66
"scripts": {

0 commit comments

Comments
 (0)