Skip to content

Commit

Permalink
Prepare for v0.1.2 (#15)
Browse files Browse the repository at this point in the history
Whats changed:
- Fix default archive label in #10 
- Drop support for `.bufversion` files in #8 

Removed support for `.bufversion` files is a breaking change but is not
currently used by known implementations.
  • Loading branch information
emcfarlane authored Jun 5, 2024
1 parent d52db49 commit 0a9a3ef
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 23 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
Expand Down Expand Up @@ -81,7 +81,7 @@ This will install `buf` and optionally login to the schema registry but no addit
Subsequent steps will have `buf` available in their $PATH and can invoke `buf` directly.

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
setup_only: true
- run: buf build --error-format github-actions
Expand All @@ -93,7 +93,7 @@ To skip or disable parts of the workflow, each step corresponds to a boolean fla
For example to disable linting set the input `lint` to `false`:

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
lint: false
```
Expand All @@ -106,7 +106,7 @@ To trigger steps on different events use the GitHub action context to deduce the
For example to enable formatting checks on both pull requests and push create an expression for the input `format`:

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
format: ${{ contains(fromJSON('["push", "pull_request"]'), github.event_name) }}
```
Expand All @@ -119,7 +119,7 @@ To conditionally run checks based on user input, use the GitHub action context t
For example to disable breaking change detection on commits, create an expression on the input `breaking` to check the contents of the commit message:

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
breaking: |
contains(fromJSON('["push", "pull_request"]'), github.event_name) &&
Expand All @@ -133,7 +133,7 @@ See [GitHub Actions job context](https://docs.github.com/en/actions/reference/co
To ensure the version of `buf` is consistent across workflows it's recommended to always use an explicit version.

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
version: 1.32.2
```
Expand All @@ -153,7 +153,7 @@ The `username` and `token` values can be stored as secrets in the repository set
The `token` value can be [generated from the Buf Schema Registry UI](https://buf.build/docs/bsr/authentication#create-an-api-token).

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
Expand Down Expand Up @@ -191,7 +191,7 @@ runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
comment: false
```
Expand All @@ -203,7 +203,7 @@ To run the action for inputs not specified at the root of the repository, set th
Breaking change detection will also be required to be set to include a `subdir` configured to the same input path.

```yaml
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
input: protos
breaking_against: |
Expand All @@ -220,7 +220,7 @@ Alternatively, you may wish to pre-checkout the base branch for breaking changes
with:
path: base
ref: ${{ github.event.pull_request.base.sha }}
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
input: head/protos
breaking_against: base/protos
Expand Down Expand Up @@ -293,7 +293,7 @@ jobs:
contents: read
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
version: 1.32.2
username: ${{ secrets.BUF_USERNAME }}
Expand Down
2 changes: 1 addition & 1 deletion examples/buf-ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
2 changes: 1 addition & 1 deletion examples/only-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
2 changes: 1 addition & 1 deletion examples/only-setup-defaults.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
setup_only: true
- env:
Expand Down
2 changes: 1 addition & 1 deletion examples/only-setup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
# Add username or token secrets to your repository settings to
# authenticate with the Buf Schema Registry.
Expand Down
2 changes: 1 addition & 1 deletion examples/only-sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
2 changes: 1 addition & 1 deletion examples/push-on-changes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
2 changes: 1 addition & 1 deletion examples/skip-on-commits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion examples/skip-on-labels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
username: ${{ secrets.BUF_USERNAME }}
token: ${{ secrets.BUF_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion examples/validate-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
# Username and token are required to authenticate with the Buf Schema Registry.
username: ${{ secrets.BUF_USERNAME }}
Expand Down
2 changes: 1 addition & 1 deletion examples/version-env.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
setup_only: true
- run: buf version
2 changes: 1 addition & 1 deletion examples/version-input.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
setup_only: true
version: 1.32.2
Expand Down
2 changes: 1 addition & 1 deletion examples/version-latest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: bufbuild/[email protected].1
- uses: bufbuild/[email protected].2
with:
setup_only: true
- run: buf version

0 comments on commit 0a9a3ef

Please sign in to comment.