feature: Documentation command #1009
Open
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
xNok
force-pushed
the
documentation-command
branch
from
92993db
to
f9f3d0e
Compare
xNok
force-pushed
the
documentation-command
branch
from
3d36716
to
73114d4
Compare
boranx
reviewed
Oct 7, 2024
There was a problem hiding this comment.
hey @xNok
Thanks for bringing this together, I actually very liked the idea of using go templates and embedding both so if the user has their own, overriding it to balance flexibility with functionality.
This can help us collectively gather feedback on how users actually use it and refactor to get it closer to the user needs.
+1 from me on implementation.
Just left some comments at first glance, will look at more.
xNok
force-pushed
the
documentation-command
branch
2 times, most recently
from
834216c
to
e2cdeed
Compare
Signed-off-by: Alexandre Couedelo <[email protected]> refactor: change the way we access annotations I am testing different way to generate the doc. Having the compiler object is much easier than the annotation set only Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]> fix: make title coherent in submodules documentation Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]> chore: ignore golden files in git Signed-off-by: Alexandre Couedelo <[email protected]> chore: document and test the custom template feature Signed-off-by: Alexandre Couedelo <[email protected]> chore: linting Signed-off-by: Alexandre Couedelo <[email protected]>
…9.0 (open-policy-agent#1010) Bumps [github.com/open-policy-agent/opa](https://github.com/open-policy-agent/opa) from 0.68.0 to 0.69.0. - [Release notes](https://github.com/open-policy-agent/opa/releases) - [Changelog](https://github.com/open-policy-agent/opa/blob/main/CHANGELOG.md) - [Commits](open-policy-agent/opa@v0.68.0...v0.69.0) --- updated-dependencies: - dependency-name: github.com/open-policy-agent/opa dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Alexandre Couedelo <[email protected]>
build(deps): bump github.com/open-policy-agent/opa from 0.68.0 to 0.69.0 (open-policy-agent#1010) Bumps [github.com/open-policy-agent/opa](https://github.com/open-policy-agent/opa) from 0.68.0 to 0.69.0. - [Release notes](https://github.com/open-policy-agent/opa/releases) - [Changelog](https://github.com/open-policy-agent/opa/blob/main/CHANGELOG.md) - [Commits](open-policy-agent/opa@v0.68.0...v0.69.0) --- updated-dependencies: - dependency-name: github.com/open-policy-agent/opa dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Alexandre Couedelo <[email protected]> chore: go mod tidy
xNok
force-pushed
the
documentation-command
branch
from
e2cdeed
to
de4b81d
Compare
Signed-off-by: Alexandre Couedelo <[email protected]>
xNok
force-pushed
the
documentation-command
branch
from
191ca6e
to
5b32548
Compare
xNok
commented
Oct 14, 2024
xNok
commented
Oct 14, 2024
xNok
commented
Oct 14, 2024
xNok
commented
Oct 14, 2024
xNok
commented
Oct 14, 2024
Signed-off-by: Alexandre Couedelo <[email protected]>
xNok
force-pushed
the
documentation-command
branch
from
7b3dbe6
to
61b27da
Compare
jalseth
requested changes
Oct 17, 2024
jalseth Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]>
Signed-off-by: Alexandre Couedelo <[email protected]>
|
@jalseth, I have addressed your comment. It seems there is a broken test, and it fails on
|
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.
I found myself wanting to generate reference documentation for my policies, and I figured it would be nice if this was a built-in feature of conftest.
While the way of structuring the documentation can be opinionated, I think using the FlatAnnotationsRefSet is a safe bet, as OPA's core does all the heavy lifting of organizing annotations and rules.
My initial attempt was to combine
FlatAnnotationsRefSetand Go-template and offer the least opinionated approach to documentation format that can be easily overridden. However, I had some trouble properly formatting titles (H1, H2, H3, etc...) and had to introduce some custom logic to handle it. (As a side note this could potentially be handles by adding template function libraries such as sprig)