Use GitHub action context for input

README.md

@@ -32,7 +32,6 @@ jobs:
  buf:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}
@@ -159,7 +158,6 @@ jobs:
  buf:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}
@@ -169,25 +167,17 @@ jobs:
 ### Specify the input directory
 
 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.
+set the parameter `input` and `breaking_against` to include a subdir to the path
+of your `buf.yaml` file. These parameters are configured as a base input ref.
 
 ```yaml
 - uses: bufbuild/buf-action@v1
  with:
- input: <path/to/module>
-```
-
-Breaking change detection by default will use the `input` value as a subdirectory for the breaking against value.
-To customize this behavior, set the parameter `breaking_against` to the desired input.
-
-```yaml
-- uses: bufbuild/buf-action@v1
- with:
- input: <path/to/module>
+ input: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.head.sha }},subdir=<path/to/module>
  breaking_against: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.base.sha }},subdir=<path/to/module>
 ```
 
-Alternatively, you can checkout the base for the breaking comparison to a local folder
+Alternatively, you can checkout the head and base to a local folder
 and then set the value of `breaking_against` to the path of the base.
 
 ```yaml

action.yml

@@ -63,6 +63,7 @@ inputs:
  description: |-
  Input for the buf command.
  required: false
+ default: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.head.sha || github.event.after }}
  paths:
  description: |-
  Limit to specific files or directories (separated by newlines).
@@ -112,6 +113,7 @@ inputs:
  Input to compare against for breaking change detection.
  Defaults to the base branch of the pull request or the commit before the push.
  required: false
+ default: ${{ github.event.repository.clone_url }}#format=git,commit=${{ github.event.pull_request.base.sha || github.event.before }}
 
  push:
  description: |-

dist/index.js

@@ -45413,23 +45413,11 @@ function getInputs() {
  archive_labels: [],
  };
  if (lib_github.context.eventName === "push") {
- const event = lib_github.context.payload;
- if (inputs.breaking_against === "") {
- inputs.breaking_against = `${event.repository.clone_url}#format=git,commit=${event.before}`;
- if (inputs.input) {
- inputs.breaking_against += `,subdir=${inputs.input}`;
- }
- }
+ //const event = github.context.payload as PushEvent;
  inputs.archive_labels.push(lib_github.context.ref);
  }
  if (lib_github.context.eventName === "pull_request") {
- const event = lib_github.context.payload;
- if (inputs.breaking_against === "") {
- inputs.breaking_against = `${event.repository.clone_url}#format=git,commit=${event.pull_request.base.sha}`;
- if (inputs.input) {
- inputs.breaking_against += `,subdir=${inputs.input}`;
- }
- }
+ //const event = github.context.payload as PullRequestEvent;
  inputs.archive_labels.push(lib_github.context.ref);
  }
  if (lib_github.context.eventName === "delete") {

examples/disable-skip/buf-ci.yaml

@@ -14,7 +14,6 @@ jobs:
  buf:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}

examples/only-checks/buf-ci.yaml

@@ -10,5 +10,4 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1

examples/only-sync/buf-ci.yaml

@@ -9,7 +9,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}

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

@@ -18,7 +18,6 @@ jobs:
  buf:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}

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

@@ -9,7 +9,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}

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

@@ -11,7 +11,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  token: ${{ secrets.BUF_TOKEN }}

examples/validate-push/buf-ci.yaml

@@ -9,7 +9,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  # The token paramater is required to authenticate with the Buf Schema Registry.

examples/version-env/buf-ci.yaml

@@ -10,7 +10,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  setup_only: true

examples/version-input/buf-ci.yaml

@@ -8,7 +8,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  setup_only: true

examples/version-latest/buf-ci.yaml

@@ -8,7 +8,6 @@ jobs:
  buf: 
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v4
  - uses: bufbuild/buf-action@v1
  with:
  setup_only: true

src/inputs.ts

@@ -15,8 +15,8 @@
 import * as core from "@actions/core";
 import * as github from "@actions/github";
 import {
- PushEvent,
- PullRequestEvent,
+ //PushEvent,
+ //PullRequestEvent,
  DeleteEvent,
 } from "@octokit/webhooks-definitions/schema";
 
@@ -71,23 +71,11 @@ export function getInputs(): Inputs {
  archive_labels: [],
  };
  if (github.context.eventName === "push") {
- const event = github.context.payload as PushEvent;
- if (inputs.breaking_against === "") {
- inputs.breaking_against = `${event.repository.clone_url}#format=git,commit=${event.before}`;
- if (inputs.input) {
- inputs.breaking_against += `,subdir=${inputs.input}`;
- }
- }
+ //const event = github.context.payload as PushEvent;
  inputs.archive_labels.push(github.context.ref);
  }
  if (github.context.eventName === "pull_request") {
- const event = github.context.payload as PullRequestEvent;
- if (inputs.breaking_against === "") {
- inputs.breaking_against = `${event.repository.clone_url}#format=git,commit=${event.pull_request.base.sha}`;
- if (inputs.input) {
- inputs.breaking_against += `,subdir=${inputs.input}`;
- }
- }
+ //const event = github.context.payload as PullRequestEvent;
  inputs.archive_labels.push(github.context.ref);
  }
  if (github.context.eventName === "delete") {