Workflow syntax reference doesn't document top-level `description` key
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 74/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- github, yaml
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với tài liệu tham khảo cú pháp workflow trên trang tài liệu được liên kết và so sánh các khóa cấp cao nhất được ghi lại với mục description trong schema workflow được liên kết. Xem hướng dẫn đóng góp tài liệu của repository để tìm tệp nguồn và quy trình xem trước. Hoàn thành khi tài liệu tham khảo giải thích liệu description ở cấp gốc có được hỗ trợ hay không, mục đích của nó là gì và liệu nó có xuất hiện trong UI hay không.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- TypeScript
- Star
- 21.3k
- Fork
- 69.4k
- Merge trung bình
- 12 giờ 12 phút
- Pull request đã merge (30 ngày)
- 84
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/docs
-
content triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Confusing content: evaluates the expression `hash "package-lock.json"` to derive the final key `npm-d5ea0750`Có thể đã có người làm @darshpatel1052 đã nhận 4 ngày trước. Đang mởactions builder persona content
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 86/100
github/docs#46499 · 3 bình luận · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
builder persona
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
github/docs#46354 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
builder persona content copilot
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
github/docs#46334 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
on.workflow_call.inputs.<input_id> description, required and default have no headingsCó thể làm lại được Pull request cho issue này đã bị đóng mà không được merge. Đang mởactions builder persona
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
github/docs#46304 · 4 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
tensorflow/tfjs#8754 ·
-
tool-submission
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 83/100
BraveOPotato/NoSignups#2348 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
code-yeongyu/oh-my-openagent#12784 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
external-issue to-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 71/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
MomsBloomOrg/momsbloom-resources#84 ·
Maintainer thường phản hồi trong vòng 1 ngày