add small script + github action to check that public docs updated #1177
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
This PR adds a new GitHub Action which will run on PRs against
dev
andmain
. 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
orgrafana-plugin
directories. If so, it will then check whether changes were also made to thedocs
directory. If not, it will fail the job and block the build.No changes made to "engine" or "grafana-plugin" directories
Job skipped when "no public docs" label applied to PR
Changes made to "engine" and/or "grafana-plugin" directories and public docs also updated
Changes made to "engine" and/or "grafana-plugin" directories but public docs were not updated
Which issue(s) this PR fixes
N/A
Checklist
CHANGELOG.md
updated (N/A)