Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fuzzy-lambs-bow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"apidiff-go": minor
---

feat: support workflow_dispatch events, forcing base/head ref override inputs
5 changes: 5 additions & 0 deletions .changeset/ripe-foxes-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"apidiff-go": minor
---

feat: add version recommendations (patch/minor/major) based on api changes
5 changes: 5 additions & 0 deletions .changeset/simple-flames-grin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"apidiff-go": minor
---

feat: copy github step summary file, and add summary-path as an action output
5 changes: 5 additions & 0 deletions .changeset/stale-sparks-heal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"apidiff-go": patch
---

feat: add ref, and resolved ref to summary output
10 changes: 10 additions & 0 deletions actions/apidiff-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ Github event triggered the invocation.
[event payload](https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=synchronize#pull_request).
- `push` - uses the `before`/`after` from the
[event payload](https://docs.github.com/en/webhooks/webhook-events-and-payloads#push)
- `workflow_dispatch` events require `base-ref-override` and `head-ref-override`
inputs.

#### Outputs

1. `version-recommendation` - based on the changes, this will output `patch`,
`minor`, or `major`
2. `summary-path` - a copy of the summary, written to disk. To be used for
release notes if needed
- This should be written to a `summary.md` at the root of the module

### Example Workflow

Expand Down
15 changes: 15 additions & 0 deletions actions/apidiff-go/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ runs:
using: "node20"
main: "dist/index.js"

outputs:
version-recommendation:
description: |
A recommendation for the next version number based on the detected API
changes. Possible values are 'patch', 'minor', 'major'.

summary-path:
description: |
Path to the summary file generated by the action. This will be a copy of the ${GITHUB_STEP_SUMMARY} file.

inputs:
# path inputs
repository-root:
Expand Down Expand Up @@ -57,6 +67,11 @@ inputs:
default: "latest"

# misc inputs - dont touch these
github-token:
description: "GitHub token to use for authentication"
default: ${{ github.token }}
required: true

summary-url:
description:
"URL linking to the full apidiff report. This is included in the comment
Expand Down
Loading
Loading