Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Clarify 'description' key is optional for composite actions

Offen
  • Stimmt etwas nicht?
#43,910 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@mcummings128 arbeitet bereits daran.

Seit 21.4.2026.

  • #43911 von @mcummings128 — offen

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
github-actions
Bereich
documentation

Rechercherichtung

Beginne mit dem Artikel zur Metadatensyntax unter docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax und prüfe den verknüpften Pull Request auf die vorgeschlagene Formulierung. Aktualisiere die Anforderung an die Beschreibung von composite-action so, dass sie als optional gekennzeichnet ist, und weise zugleich darauf hin, dass sie dringend empfohlen wird. Überprüfe anschließend, ob der Artikel korrekt gerendert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

content github_actions never-stale
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax

What part(s) of the article would you like to see updated?

For composite actions, the description key is not strictly required in the action.yml for the composite action to function correctly (see Additional Information for proof).

Instead of Required this should either have an addendum like in the pull request (that is, that description is not required for composite actions, or change Required to optional. In either case, it is probably worth it to state that a description key is highly recommended.

Additional information

I just ran a workflow run that calls a composite action whose action.yml file did not include a description key at the time this workflow ran. The workflow ran as expected (all the composite action does is produce an output that gets passed to the calling workflow).

See https://github.com/mcummings128/gh-actions-outputs-experiments-1/actions/runs/24743176941 for details.
This commit SHA shows the description key was removed from the composite action during the time the workflow ran.
https://github.com/mcummings128/gh-actions-outputs-experiments-1/commit/6037d82f9910c7d186845393ab2b4a53617b2bde

Lastly, please see the pull request this is linked to: https://github.com/github/docs/pull/43911

Vorherrschende Sprache
TypeScript
Sterne
21k
Forks
69k
Ø Merge
8 Std. 37 Min.
Gemergte PRs (30 T.)
117

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/docs

Alle Issues in github/docs

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.