Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add support for message output #32

Merged
merged 8 commits into from
Oct 9, 2023
Merged

fix: add support for message output #32

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
25f8820
fix: add support for message output
wtrocki Aug 28, 2023
8230bf5
docs: add documentation
wtrocki Aug 28, 2023
633d6ee
chore: docs update
wtrocki Oct 4, 2023
2499665
fix: multiline
wtrocki Oct 4, 2023
c5dd1a1
Update action.yml
wtrocki Oct 4, 2023
134e366
fix: formatting
wtrocki Oct 4, 2023
b3991bd
fix: output
wtrocki Oct 6, 2023
62ec8a1
Update action.yml
wtrocki Oct 9, 2023
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Skip automatic caching of go module directories (default: `false`)

Returns the type (patch, minor, major) of the sementic version that would be required if producing a release.

#### `message`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we call this output instead of message? output seems a bit more intuitive, at least to me, because this will have the full output of the go-apidiff command.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


Returns the string containing text explaining API changes. The string can be empty if no changes are present.


### Example usage

```yaml
Expand Down
1 change: 1 addition & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,5 @@ runs:
exit 0
fi
echo "semver-type=major" >> $GITHUB_OUTPUT
echo "message=$OUTPUT" >> $GITHUB_OUTPUT
exit $GOAPIDIFF_RC