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.

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

Simplify example code? #144

Closed
waldyrious opened this issue Aug 27, 2021 · 2 comments
Closed

Simplify example code? #144

waldyrious opened this issue Aug 27, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@waldyrious
Copy link
Contributor

The current usage example already omits some of the available configurations, like missingUpdateErrorMessage and expectedLatestVersion. Since CHANGELOG.md seems to be pretty common for changelog files, and is already the default value for changeLogPath, maybe it could be omitted as well, to simplify the example code?

Additionally, perhaps the on.pull_request.types field could be removed as well, and mentioned in the documentation as a possible customization, since the default behavior for on.pull_request seems to sufficient for most use cases (it gets triggered in the opened, synchronize and reopened events), and the extra complexity of adding the types field might not be warranted for a "getting started" example.

Both changes would greatly improve the experience of first-time users (in particular, GitHub Actions beginners), since every extra line of config introduces concepts and complexity that quickly add up and make the hurdle of adopting this action a little bit harder. (On that note, thanks for the already excellent and comprehensive documentation!)

@dangoslen
Copy link
Owner

This makes sense to me. I'll simplify the changeLogPath.

I do want to keep the on.pull_request.types since they don't include labeled or unlabeled which is a key part of this action.

As a follow-up, I think I'll add a section of "examples" for a few more complicated use cases. I've been meaning to do that anyway.

I'll tag you on a PR - or feel free to open a PR to address the usage example and I'm happy to review. Just checkout from master and I'll make sure the commits get to the right version branch

@waldyrious
Copy link
Contributor Author

I'll try to find time to submit a PR during the weekend, unless you get to it first :)

Specifically, I would perhaps add a note (e.g. a comment in the example yml file, or in the warning shown underneath it.) explaining why the types field is needed.

This was referenced Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants