CI: check if docs need to be regenerated #362
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Integralist
force-pushed
the
integralist/20210201_docs_ci
branch
from
c7890ed
to
e0b0a82
Compare
Integralist
force-pushed
the
integralist/20210201_docs_ci
branch
from
abfff99
to
6647eba
Compare
Integralist
force-pushed
the
integralist/20210201_docs_ci
branch
from
2994ea8
to
8c0d9c7
Compare
Integralist
force-pushed
the
integralist/20210201_docs_ci
branch
from
0a59406
to
b1be7c3
Compare
Integralist
requested review from
phamann,
a team and
kailan
and removed request for
a team
Integralist
requested review from
a team and
doramatadora
and removed request for
a team
|
@doramatadora @phamann ready for review. |
phamann
approved these changes
Feb 4, 2021
Integralist
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If a change is made to a schema
Descriptionfield and a PR is opened, then we would like to be able to identify to the author of the PR that the documentation needs to be regenerated (e.g. by runningmake generate-docs).The solution is to have a Github workflow which runs the relevant Makefile target and then runs
git diffto see if there's any changes to what's in the main branch. If there are changes, it means new documentation files were generated in CI and so the author of the PR should run the relevant Makefile target locally and commit those changes.