Skip to content

docs: clarify description key is optional for composite actions - #46247

Open
Xiyu-z wants to merge 1 commit into
github:mainfrom
Xiyu-z:fix-composite-action-description-optional
Open

Xiyu-z wants to merge 1 commit into
github:mainfrom
Xiyu-z:fix-composite-action-description-optional

Conversation

@Xiyu-z

@Xiyu-z Xiyu-z commented Oct 10, 2026

Copy link
Copy Markdown

Mark description field as optional for composite actions and add recommendation note.

Why:

The documentation previously stated the description field 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 description metadata field under composite actions, and added a note that it is highly recommended to include a description.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content
  • All CI checks are passing and the changes look good in the review environment.

Mark description field as optional for composite actions and add recommendation note.
@welcome

welcome Bot commented Oct 10, 2026

Copy link
Copy Markdown

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.

@github-actions

Copy link
Copy Markdown
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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/reference/workflows-and-actions/metadata-syntax.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Oct 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content/actions/reference/workflows-and-actions/metadata-syntax.md

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify 'description' key is optional for composite actions

2 participants