bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

Đang mở
#2,893 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
sphinxdocs
Ngôn ngữ chính
Starlark
Star
688
Fork
721
Merge trung bình
15 giờ 7 phút
Pull request đã merge (30 ngày)
76

Mô tả

GitHub actions support specially formatted output that can then show up in the ui: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-warning-message

So the idea would be: have a bazel flag and/or sphinx plugin that transforms warning/error messages that occur during docs building into that format. They can then show up in the code review UI.

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

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

Hướng nghiên cứu

Start by reviewing the GitHub Actions workflow-command format linked in the issue and how the Sphinx documentation build exposes warning and error output. Determine whether a Bazel flag or Sphinx plugin is the appropriate entry point; done means documentation build messages are emitted in a format that GitHub can display in the code review UI.

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

Đánh giá

Công nghệ
github-actions
Lĩnh vực
ci-cd, documentation
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
35/100

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.