Clarify 'description' key is optional for composite actions

Abierto
#43,910 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
github-actions
Área
documentation

Línea de trabajo

Comienza con el artículo sobre la sintaxis de metadatos en docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax y revisa el pull request vinculado para comprobar la redacción propuesta. Actualiza el requisito de descripción de composite-action para reflejar que es opcional, indicando a la vez que se recomienda encarecidamente, y verifica después que el artículo se renderiza correctamente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
20.9k
Forks
68.8k
Merge medio
15 h 4 min
PR fusionados (30 d)
103

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/docs

Todos los issues de github/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.