Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CI: Check for updated README for sample.conf changes #11303

Closed
srebhan opened this issue Jun 14, 2022 · 1 comment · Fixed by #11495
Closed

CI: Check for updated README for sample.conf changes #11303

srebhan opened this issue Jun 14, 2022 · 1 comment · Fixed by #11495
Assignees
@sspaink
Labels
feature request Requests for new plugin and for new features to existing plugins size/s 1 day effort, great beginniner issue

Comments

@srebhan
Copy link
Member

srebhan commented Jun 14, 2022

Feature Request

Add a CI check to make sure the README.md files were updated in case the sample.conf file(s) changed. This ensures that the user/developer-facing documentation matches what is actually in the code.

Proposal:

Add a CI action to checkout a PR and run make docs. As a result there should be no changes to the checked-out code.
@srebhan srebhan added the feature request Requests for new plugin and for new features to existing plugins label Jun 14, 2022
@sspaink sspaink self-assigned this Jun 14, 2022
@powersj
Copy link
Contributor

powersj commented Jun 14, 2022

next steps: add make docs to the CI test jobs (e.g. linux-test) and then afterward run `git status --porcelain to see if the tree is now dirty post-check-out.

@powersj powersj added the size/s 1 day effort, great beginniner issue label Jun 14, 2022
@sspaink sspaink mentioned this issue Jul 12, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sspaink sspaink

Labels
feature request Requests for new plugin and for new features to existing plugins size/s 1 day effort, great beginniner issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: Check for readme changes in each PR influxdata/telegraf
3 participants
@sspaink @powersj @srebhan