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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với bài viết về cú pháp siêu dữ liệu tại docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax và xem xét pull request được liên kết để kiểm tra cách diễn đạt được đề xuất. Cập nhật yêu cầu về phần mô tả của composite-action để phản ánh rằng phần này là tùy chọn, đồng thời nêu rõ rằng phần này rất được khuyến nghị, sau đó xác minh rằng bài viết được kết xuất chính xác.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

content github_actions
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

Ngôn ngữ chính
TypeScript
Star
20.9k
Fork
68.8k
Merge trung bình
13 giờ 55 phút
Pull request đã merge (30 ngày)
105

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

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/docs

Tất cả issue của github/docs

Issue tương tự

Thêm issue về TypeScript

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.