Explain that workflows that submit sarif probably shouldn't fail
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
- 76/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-actions
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với phần “Uploading code scanning data to GitHub” trong bài viết về thiết lập nâng cao được liên kết, sau đó xem lại tài liệu về tải SARIF lên được liên kết và ngữ cảnh của upload-sarif action. Cập nhật hướng dẫn để người đọc hiểu hành vi exit-code dự kiến đối với các workflow gửi SARIF, đồng thời xác minh rằng phần giải thích sau khi cập nhật khớp với hành vi workflow được ghi trong tài liệu.
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?
What part(s) of the article would you like to see updated?
Uploading code scanning data to GitHub
Says:
GitHub can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the
upload-sarif action. For more information, see Uploading a SARIF file to GitHub.
It doesn't say anything about exit codes for such workflows.
(It doesn't link to the upload-sarif action, which may be for the best as using that will delay workflows by 6 seconds. -- The action is intentionally not listed in the GitHub Marketplace unlike, e.g. checkout.)
Additional information
Normally if you want to prevent a pull request from being merged, you'd have your workflow "fail" triggering an ❌.
But, if you do that for a workflow that submits sarifs (at least using some of the apis, especially the github/codeql-action/upload-sarif), then you'll get:
And the status link goes to:
- Ngôn ngữ chính
- TypeScript
- Star
- 20.9k
- Fork
- 68.8k
- Merge trung bình
- 12 giờ 41 phút
- Pull request đã merge (30 ngày)
- 120
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ó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
-
localization
Độ khó 2/5 1-2 ngày Mức phù hợp với người mới 72/100
-
content localization
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
content localization
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
-
content dependabot needs SME
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
Issue tương tự
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Crush Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
ElementsProject/cln-application#167 · 1 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Quantco/pnpm-licenses#17 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100