bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

Offen
#2,893 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
sphinxdocs
Vorherrschende Sprache
Starlark
Sterne
688
Forks
721
Ø Merge
15 Std. 7 Min.
Gemergte PRs (30 T.)
76

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github-actions
Bereich
ci-cd, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.