docs: clarify description key is optional for composite actions

[Xiyu-z]

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.

[welcome]

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]

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

• Spin up a codespace
• Set up a local development environment

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.

[samyelzoghby01-lang]

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

[brianwhitneyhoffmann093-beep]

Arrest Records. On Sun, Oct 11, 2026 at 12:48 PM Brian Whitney Hoffmann < ***@***.***> wrote:

…

On Fri, Oct 9, 2026 at 8:42 PM samyelzoghby01-lang < ***@***.***> wrote: > ***@***.**** commented on this pull request. > ------------------------------ > > On content/actions/reference/workflows-and-actions/metadata-syntax.md > <#46247 (comment)>: > > content/actions/reference/workflows-and-actions/metadata-syntax.md > > — > Reply to this email directly, view it on GitHub > <#46247?email_source=notifications&email_token=CQBY3NKNBIYSNRUCCU6XPRL5TGV2TA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTKNBXG4ZTOMBUGE32M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSWGM33PORSXEX3DNRUWG2Y#pullrequestreview-5477370417>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/CQBY3NK64MV543IWBCMO3DT5TGV2TAVCNFSNUABFKJSXA33TNF2G64TZHMYTQOJWGIYTMMBXHNEXG43VMU5TKNZYG42TKMJYGE2KC5QC> > . > Triage notifications, keep track of coding agent tasks and review pull > requests on the go with GitHub Mobile for iOS > <https://github.com/notifications/mobile/ios/CQBY3NOWMLOQZLM4DK7ZNV35TGV2TA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTKNBXG4ZTOMBUGE32M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSVGM33PORSXEX3JN5ZQ> > and Android > <https://github.com/notifications/mobile/android/CQBY3NJTQQCTTEL36QI3SID5TGV2TA5CNFSNUABKM5UWIORPF5TWS5BNNB2WEL2QOVWGYUTFOF2WK43UKJSXM2LFO4XTKNBXG4ZTOMBUGE32M4TFMFZW63VKON2WE43DOJUWEZLEUVSXMZLOOSXGM33PORSXEX3BNZSHE33JMQ>. > Download it today! > You are receiving this because you are subscribed to this thread.Message > ID: ***@***.***> >