Update note on action description requirement#43911
Open
mcummings128 wants to merge 1 commit into
Open
Conversation
Clarified that the description is not required for composite actions. As a proof of concept, I deleted my 'description' key from my composite action and called it, with everything still working.
1 task
github-actions
Bot
added
the
triage
Contributor
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
Sharra-writes
added
content
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Clarified that the description is not required for composite actions.
As a proof of concept, I deleted my 'description' key from my composite action and called it, with everything still working.
Why:
Closes: #43910
What's being changed (if available, include any code snippets, screenshots, or gifs):
Per the issue linked above:
"For composite actions, the
descriptionkey is not strictly required for the composite action to function correctly (see Additional Information [in the issue] for proof).Instead of 'Required' this should either have an addendum like in the pull request (that is, that
descriptionis not required for composite actions, or change Required to optional. In either case, it is probably worth it to state that adescriptionkey is highly recommended."Check off the following: