envoyproxy/envoy

Notify on Pull Requests when documentation is rendered in CI

Aperta

#13.294 aperta il 28 set 2020

 (4 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docshelp wanted

Metriche repository

Star
 (27.997 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor