-
Notifications
You must be signed in to change notification settings - Fork 364
feat: validate other parameters against command parameter when used #1445
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
feat: validate other parameters against command parameter when used #1445
Conversation
|
4a380e5
to
0e2d89e
Compare
0e2d89e
to
f85f4d5
Compare
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good idea. I wonder if an error state is desirable over a warning, but having this warning is a good first step to verify issues anyway.
🎉 This PR is included in version 6.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
The validation does not stop the workflow running and it can still be successful running the command specified in the A error message (rather than a warning) would fit better together with failing the workflow. That however would be a breaking change and I don't think it is necessary or desirable to fail such a workflow at this time. We can revisit after seeing if there is any specific feedback on the change. The main goal was to inform workflow authors that their parameter(s) would be ignored in this situation, so that they have the information to review their parameters and make corrections. Moving from warning to failing at a later time would be like first deprecating a function then removing it at a later time. The timeline for a transition like this should be at least a few months. |
command
parameter are used #1439Situation
When the input parameter
command
is used (see README > Custom test command) then multiple other command parameters are ignored without error or warning.If related string parameters are set then they will be ignored.
Boolean input parameters are ignored if they are set different from their default settings.
Change
Validate input parameters used together with the
command
parameter and emit a GitHub Actions annotations warning if any ignored parameters are being used.Example warning
This example contains all possible ignored parameters: