Repository navigation
Conversation
Mark description field as optional for composite actions and add recommendation note.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
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. |
There was a problem hiding this comment.
content/actions/reference/workflows-and-actions/metadata-syntax.md
Mark description field as optional for composite actions and add recommendation note.
Why:
The documentation previously stated the
descriptionfield was required for composite actions, but composite actions can run without this field. This update clarifies that it is optional while still recommending users to provide it.Closes #43910
What's being changed:
Changed "Required" to "Optional" for the
descriptionmetadata field under composite actions, and added a note that it is highly recommended to include a description.Check off the following: