Workflow syntax reference doesn't document top-level `description` key
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 74/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- github, yaml
- Domaine
- documentation
Piste de recherche
Commence par la référence de syntaxe des workflows sur la page de documentation liée et compare ses clés de premier niveau documentées à l’entrée description du schéma de workflow lié. Consulte les consignes de contribution à la documentation du dépôt pour trouver le fichier source et le workflow de prévisualisation. La tâche est terminée lorsque la référence explique si description est prise en charge à la racine, à quoi elle sert et si elle apparaît dans l’UI.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- TypeScript
- Étoiles
- 21.3k
- Forks
- 69.4k
- Merge moyen
- 12 h 12 min
- PR mergées (30 j)
- 84
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/docs
-
content triage
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Confusing content: evaluates the expression `hash "package-lock.json"` to derive the final key `npm-d5ea0750`Peut-être pris @darshpatel1052 l’a pris il y a 4 jours. Ouverteactions builder persona content
Difficulté 1/5 Moins d'une heure Accessibilité débutants 86/100
github/docs#46499 · 3 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
builder persona
Difficulté 1/5 1-3 heures Accessibilité débutants 88/100
github/docs#46354 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
builder persona content copilot
Difficulté 1/5 1-3 heures Accessibilité débutants 72/100
github/docs#46334 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
on.workflow_call.inputs.<input_id> description, required and default have no headingsPeut-être à nouveau libre Une pull request pour cette issue a été fermée sans être fusionnée. Ouverteactions builder persona
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
github/docs#46304 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de github/docs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Difficulté 1/5 Moins d'une heure Accessibilité débutants 83/100
BraveOPotato/NoSignups#2348 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
code-yeongyu/oh-my-openagent#12784 ·
Les mainteneurs répondent en général sous 1 jour
-
external-issue to-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 71/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
MomsBloomOrg/momsbloom-resources#84 ·
Les mainteneurs répondent en général sous 1 jour