Move comment re: "Unexpected input(s)" warnings for octokit/request-action to first usage
#19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…action` to first usage The `octokit/request-action` GitHub Actions action is designed to accept API request parameters as arbitrary action inputs in the workflow. Because they have made no attempt to define all possible input keys in the action metadata, normal and correct usage of the action cases GitHub Actions to display warnings in the workflow run log and summary. For example: Unexpected input(s) 'owner', 'repo', 'issue_number', 'labels', valid inputs are ['route', 'mediaType'] This has the potential to cause confusion, so I added a comment to the workflow explaining that this warning is expected and doesn't indicate a problem. That comment somehow ended on a random occurence of `octokit/request-action` in the workflow. It makes most sense to put it on the first usage of the action in the workflow, to make the information easy to find.
Contributor
|
Hi @per1234. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
per1234
added
topic: documentation
silvanocerza
approved these changes
Apr 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
octokit/request-actionGitHub Actions action is designed to accept API request parameters as arbitrary actioninputs in the workflow. Because they have made no attempt to define all possible input keys in the action metadata,
normal and correct usage of the action cases GitHub Actions to display warnings in the workflow run log and summary. For
example:
This has the potential to cause confusion, so I added a comment to the workflow explaining that this warning is expected
and doesn't indicate a problem. That comment somehow ended on a random occurence of
octokit/request-actionin theworkflow. It makes most sense to put it on the first usage of the action in the workflow, to make the information easy to
find.