bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

オープン
#2,893 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
sphinxdocs
主要言語
Starlark
スター
688
フォーク
721
平均マージ
15時間 7分
マージ済み PR(30日)
76

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions
領域
ci-cd, documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。