envoyproxy/envoy

Notify on Pull Requests when documentation is rendered in CI

Open

#13.294 geöffnet am 28. Sept. 2020

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docshelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

description

when you make changes to documentation its rendered by CircleCI.

I think it would be useful for reviewers and contributors if the repo bot posted a message containing a link to the rendered docs.

I can imagine this working in one of 2 ways

posting the first time a change is noticed (and rendered)

im guessing the condition for this would be similar to the trigger used to notify api-shepherds etc when api changes happen - except for that it should wait until the docs have been rendered

posting every time docs changes happen (and are rendered)

i think this would be a bit more complex and would involve comparing commits in the PR or perhaps cached artefacts

in some ways this would be more useful - because you would have the most up-to-date link - but in other ways it would be a bit more of a thread-hog

refs

Contributor Guide

Research-Richtung
Untersuchen Sie, wie CircleCI Artefakte generiert und verlinkt werden und wie Sie die GitHub API verwenden, um Kommentare zu Pull Requests zu posten. Sehen Sie sich vorhandene Bot Implementierungen im envoy Repository für Muster an.
Tech Stack
Keine
Domain
ci cddocumentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGitHub APICircleCI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65