envoyproxy/envoy

Notify on Pull Requests when documentation is rendered in CI

Open

#13,294 opened on 2020年9月28日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (平均マージ 8d) (30d で 378 merged PRs)

説明

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

コントリビューターガイド