bazel-contrib / bazel-contrib/rules_python

sphinxdocs: output github actions workflow command compatible output

Ouverte
#2,893 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
sphinxdocs
Langage dominant
Starlark
Étoiles
688
Forks
721
Merge moyen
15 h 7 min
PR mergées (30 j)
76

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner le format des commandes de workflow de GitHub Actions lié dans l’issue et la manière dont le build de documentation Sphinx expose les sorties d’avertissement et d’erreur. Déterminez si un flag Bazel ou un plugin Sphinx constitue le point d’entrée approprié ; la tâche est considérée comme terminée lorsque les messages du build de documentation sont émis dans un format que GitHub peut afficher dans l’interface de revue de code.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
github-actions
Domaine
ci-cd, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.