From 0a62b9ddd0ca0168f6286fb16e7e5c016fee3e3a Mon Sep 17 00:00:00 2001 From: Edward McFarlane Date: Tue, 30 Jul 2024 22:25:38 +0200 Subject: [PATCH] Prepare for v0.3.0 --- README.md | 24 ++++++++++++------------ examples/buf-ci.yaml | 2 +- examples/disable-skip/buf-ci.yaml | 2 +- examples/only-checks/buf-ci.yaml | 2 +- examples/only-setup-defaults/buf-ci.yaml | 2 +- examples/only-setup/buf-ci.yaml | 2 +- examples/only-sync/buf-ci.yaml | 2 +- examples/push-on-changes/buf-ci.yaml | 2 +- examples/skip-on-commits/buf-ci.yaml | 2 +- examples/skip-on-labels/buf-ci.yaml | 2 +- examples/validate-push/buf-ci.yaml | 2 +- examples/version-env/buf-ci.yaml | 2 +- examples/version-input/buf-ci.yaml | 2 +- examples/version-latest/buf-ci.yaml | 2 +- package-lock.json | 4 ++-- package.json | 2 +- 16 files changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index ac4761b..1a388a7 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} ``` @@ -56,7 +56,7 @@ To customize the behavior of the action, you can set the following parameters in Add these parameters under the `with` section of the `uses` step in the workflow file. ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: ... ``` @@ -101,7 +101,7 @@ To disable parts of the workflow, each step corresponds to a boolean flag in the For example to disable formatting set the parameter `format` to `false`: ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: format: false ``` @@ -113,7 +113,7 @@ See [action.yml](action.yml) for all available parameters. For reproducible builds, you can pin to an explicit version of `buf` by setting `version`. ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: version: 1.35.0 ``` @@ -133,7 +133,7 @@ To authenticate with the BSR, set the API token as the parameter `token`. 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). ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} ``` @@ -163,7 +163,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} + pr_comment: false @@ -175,7 +175,7 @@ To run the action for parameters not declared at the root of the repository, set the parameter `input` to the directory of your `buf.yaml` file. ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: input: ``` @@ -184,7 +184,7 @@ Breaking change detection by default will use the `input` value as a subdirector To customize this behavior, set the parameter `breaking_against` to the desired input. ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: input: breaking_against: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.base.sha }},subdir= @@ -201,7 +201,7 @@ and then set the value of `breaking_against` to the path of the base. with: path: base ref: ${{ github.event.pull_request.base.sha }} -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: input: head/ breaking_against: base/ @@ -216,7 +216,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/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: setup_only: true - 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 For example to enable formatting checks on both pull requests and push create an expression for the parameter `format`: ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: format: ${{ contains(fromJSON('["push", "pull_request"]'), github.event_name) }} ``` @@ -243,7 +243,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 parameter `breaking` to check the contents of the commit message: ```yaml -- uses: bufbuild/buf-action@v0.2 +- uses: bufbuild/buf-action@v0.3 with: breaking: | contains(fromJSON('["push", "pull_request"]'), github.event_name) && diff --git a/examples/buf-ci.yaml b/examples/buf-ci.yaml index e48d61e..2f68509 100644 --- a/examples/buf-ci.yaml +++ b/examples/buf-ci.yaml @@ -13,6 +13,6 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} diff --git a/examples/disable-skip/buf-ci.yaml b/examples/disable-skip/buf-ci.yaml index da652b7..4f340d8 100644 --- a/examples/disable-skip/buf-ci.yaml +++ b/examples/disable-skip/buf-ci.yaml @@ -15,7 +15,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} breaking: ${{ github.event_name == 'pull_request' }} diff --git a/examples/only-checks/buf-ci.yaml b/examples/only-checks/buf-ci.yaml index d489521..818269d 100644 --- a/examples/only-checks/buf-ci.yaml +++ b/examples/only-checks/buf-ci.yaml @@ -11,4 +11,4 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 diff --git a/examples/only-setup-defaults/buf-ci.yaml b/examples/only-setup-defaults/buf-ci.yaml index b5c57e1..ef1dca7 100644 --- a/examples/only-setup-defaults/buf-ci.yaml +++ b/examples/only-setup-defaults/buf-ci.yaml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: setup_only: true - env: diff --git a/examples/only-setup/buf-ci.yaml b/examples/only-setup/buf-ci.yaml index 6bd4ce0..febe032 100644 --- a/examples/only-setup/buf-ci.yaml +++ b/examples/only-setup/buf-ci.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: # Add the parameter token as a secret in your repository settings # to authenticate with the Buf Schema Registry. diff --git a/examples/only-sync/buf-ci.yaml b/examples/only-sync/buf-ci.yaml index f986623..2e5abda 100644 --- a/examples/only-sync/buf-ci.yaml +++ b/examples/only-sync/buf-ci.yaml @@ -10,6 +10,6 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} diff --git a/examples/push-on-changes/buf-ci.yaml b/examples/push-on-changes/buf-ci.yaml index 3ed58bc..1167a5a 100644 --- a/examples/push-on-changes/buf-ci.yaml +++ b/examples/push-on-changes/buf-ci.yaml @@ -19,6 +19,6 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} diff --git a/examples/skip-on-commits/buf-ci.yaml b/examples/skip-on-commits/buf-ci.yaml index c8a7646..dc78a93 100644 --- a/examples/skip-on-commits/buf-ci.yaml +++ b/examples/skip-on-commits/buf-ci.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} lint: | diff --git a/examples/skip-on-labels/buf-ci.yaml b/examples/skip-on-labels/buf-ci.yaml index cb38c63..ae48b3b 100644 --- a/examples/skip-on-labels/buf-ci.yaml +++ b/examples/skip-on-labels/buf-ci.yaml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: token: ${{ secrets.BUF_TOKEN }} lint: | diff --git a/examples/validate-push/buf-ci.yaml b/examples/validate-push/buf-ci.yaml index 82cc3ba..4a7a175 100644 --- a/examples/validate-push/buf-ci.yaml +++ b/examples/validate-push/buf-ci.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: # The token paramater is required to authenticate with the Buf Schema Registry. token: ${{ secrets.BUF_TOKEN }} diff --git a/examples/version-env/buf-ci.yaml b/examples/version-env/buf-ci.yaml index bf970ac..44a619c 100644 --- a/examples/version-env/buf-ci.yaml +++ b/examples/version-env/buf-ci.yaml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: setup_only: true - run: buf version diff --git a/examples/version-input/buf-ci.yaml b/examples/version-input/buf-ci.yaml index 380513c..4f340fe 100644 --- a/examples/version-input/buf-ci.yaml +++ b/examples/version-input/buf-ci.yaml @@ -9,7 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: setup_only: true version: 1.35.0 diff --git a/examples/version-latest/buf-ci.yaml b/examples/version-latest/buf-ci.yaml index ed79196..f079ac0 100644 --- a/examples/version-latest/buf-ci.yaml +++ b/examples/version-latest/buf-ci.yaml @@ -9,7 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: bufbuild/buf-action@v0.2 + - uses: bufbuild/buf-action@v0.3 with: setup_only: true - run: buf version diff --git a/package-lock.json b/package-lock.json index dd4ed89..a75d593 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "buf-action", - "version": "0.2.2", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "buf-action", - "version": "0.2.2", + "version": "0.3.0", "license": "Apache-2.0", "dependencies": { "@actions/core": "^1.10.1", diff --git a/package.json b/package.json index 8f3e891..401ee76 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "buf-action", - "version": "0.2.2", + "version": "0.3.0", "description": "GitHub Action for buf", "main": "src/main.ts", "scripts": {