Workflow syntax reference doesn't document top-level `description` key
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 74/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- github, yaml
- Bereich
- documentation
Rechercherichtung
Beginne mit der Referenz zur Workflow-Syntax auf der verlinkten Dokumentationsseite und vergleiche deren dokumentierte Schlüssel der obersten Ebene mit dem Eintrag description im verlinkten Workflow-Schema. Prüfe in den Beitragsrichtlinien für die Dokumentation des Repositorys die Quelldatei und den Vorschau-Workflow. Fertig ist die Aufgabe, wenn die Referenz erklärt, ob description auf der Stammebene unterstützt wird, welchem Zweck sie dient und ob sie in der UI erscheint.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax
What part(s) of the article would you like to see updated?
The top-level keys documented are name, run-name, on, permissions, env, defaults, concurrency, cache-mode and jobs. There's no entry for description.
GitHub's own workflow schema has accepted a root-level description since January 2025:
- actions/languageservices@50b08a3 ("Add root-level description keyword") added it to
workflow-rootinworkflow-v1.0.json, with the description "A description for your workflow or reusable workflow", plus a test fixture. - The same key is in the runner's copy of the schema: actions/runner
src/Sdk/WorkflowParser/workflow-v1.0.json.
Could the reference add a description section saying whether it's supported, what it's for (e.g. describing reusable workflows), and whether it's shown anywhere in the UI?
Additional information
Because it isn't documented, third-party tools that follow the docs reject it. actionlint (v1.7.12, latest) reports unexpected key "description" for "workflow" section, and the SchemaStore github-workflow.json schema, used by many editors' YAML validation, doesn't allow it either. Meanwhile the official GitHub Actions VS Code extension accepts it. We ran into this reviewing a reusable workflow, where different tools gave opposite answers about whether the file was valid.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 21.3k
- Forks
- 69.4k
- Ø Merge
- 12 Std. 12 Min.
- Gemergte PRs (30 T.)
- 84
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus github/docs
-
content triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
Confusing content: evaluates the expression `hash "package-lock.json"` to derive the final key `npm-d5ea0750`Evtl. vergeben @darshpatel1052 hat das vor 4 Tagen übernommen. Offenactions builder persona content
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 86/100
github/docs#46499 · 3 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
builder persona
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100
github/docs#46354 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
builder persona content copilot
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 72/100
github/docs#46334 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
on.workflow_call.inputs.<input_id> description, required and default have no headingsEvtl. wieder frei Ein Pull Request dazu wurde ohne Merge geschlossen. Offenactions builder persona
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
github/docs#46304 · 4 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 83/100
BraveOPotato/NoSignups#2348 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
code-yeongyu/oh-my-openagent#12784 ·
Maintainer antworten meist innerhalb von 1 Tag
-
external-issue to-triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 71/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
MomsBloomOrg/momsbloom-resources#84 ·
Maintainer antworten meist innerhalb von 1 Tag