github / github/docs

Clarify 'description' key is optional for composite actions

Đang mở
#43,910 5 bình luận 0 reaction 0 người được giao Xem trên GitHub
content github_actions
Ngôn ngữ chính
TypeScript
Star
20.8k
Fork
68.7k
Merge trung bình
12 giờ 24 phút
Pull request đã merge (30 ngày)
105

Mô tả

### Code of Conduct

- [x] I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)

### 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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.