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.

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

add small script + github action to check that public docs updated #1177

Merged
merged 1 commit into from
Jan 20, 2023

Conversation

joeyorlando
Copy link
Contributor

@joeyorlando joeyorlando commented Jan 20, 2023

What this PR does

This PR adds a new GitHub Action which will run on PRs against dev and main. The GitHub action will not run if the label of "no public docs" has been applied to the PR in question:

Otherwise, it will check to see if any changes were made to either the engine or grafana-plugin directories. If so, it will then check whether changes were also made to the docs directory. If not, it will fail the job and block the build.

No changes made to "engine" or "grafana-plugin" directories
Screenshot 2023-01-20 at 13 06 50

Job skipped when "no public docs" label applied to PR
Screenshot 2023-01-20 at 13 08 46

Changes made to "engine" and/or "grafana-plugin" directories and public docs also updated
Screenshot 2023-01-20 at 13 07 19

Changes made to "engine" and/or "grafana-plugin" directories but public docs were not updated
Screenshot 2023-01-20 at 13 06 09

Which issue(s) this PR fixes

N/A

Checklist

  • Tests updated (N/A)
  • Documentation added (N/A)
  • CHANGELOG.md updated (N/A)

@joeyorlando joeyorlando requested a review from a team January 20, 2023 12:04
@joeyorlando joeyorlando added pr:no public docs Added to a PR that does not require public documentation updates no changelog labels Jan 20, 2023
@joeyorlando joeyorlando force-pushed the jorlando/public-docs-checker branch from 2f71ced to 1d75cc9 Compare January 20, 2023 12:14
@joeyorlando joeyorlando merged commit d3a098d into dev Jan 20, 2023
@joeyorlando joeyorlando deleted the jorlando/public-docs-checker branch January 20, 2023 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr:no public docs Added to a PR that does not require public documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants