envoyproxy/envoy

Notify on Pull Requests when documentation is rendered in CI

Open

#13,294 opened on Sep 28, 2020

View on 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
 (Avg merge 8d) (378 merged PRs in 30d)

Description

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 direction
Investigate how CircleCI artifacts are generated and linked, and how to use the GitHub API to post comments on pull requests. Look at existing bot implementations in the envoy repository for patterns.
Tech stack
None
Domain
ci cddocumentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub APICircleCI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65