Add generate docs workflow #97
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
We would like to be able to run assert in CI that running `make generate-docs` will not change the output of the documentation. This avoids issues where someone manually modifies bits of the docs that are supposed to be generated. However, we have a few tools that use files from libbpf as input, which so far we have been pulling from the `master` branch which is always in flux. This means that the output of the tools can change between runs. So, lets use a pinned commit hash for the libbpf reference. We will manually have to update it periodically to pull in changes from libbpf. Signed-off-by: Dylan Reimerink <dylan.reimerink@isovalent.com>
The BPF-HID kfuncs are present in two sets, with different flags in each set, and different allowed program types. Our current tooling is not smart enough to merge these when generating a single kfunc page. In addition, the set of allowed program types has changed over time for some of these, something our tool also currently cannot handle. So for now, switch these to manual management, so that doc generation produces stable results. Perhaps we can later improve the tooling to handle these cases. Signed-off-by: Dylan Reimerink <dylan.reimerink@isovalent.com>
dylandreimerink
force-pushed
the
feature/doc-generate-ci
branch
from
d6eacc5 to
c7b7be3
Compare
This workflow will call the `make generate-docs` command and error if the command fails or if it causes any changes to the repository. Signed-off-by: Dylan Reimerink <dylan.reimerink@isovalent.com>
dylandreimerink
force-pushed
the
feature/doc-generate-ci
branch
2 times, most recently
from
5c7ff9b to
814887e
Compare
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.
This PR makes our docs generation more stable and adds a CI workflow that asserts the docs have been properly generated.