Generate documentation using go templates#1500
Merged
zregvart merged 7 commits intoconforma:mainfrom Apr 12, 2024
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1500 +/- ##
==========================================
+ Coverage 80.46% 86.99% +6.52%
==========================================
Files 67 78 +11
Lines 4782 5122 +340
==========================================
+ Hits 3848 4456 +608
+ Misses 934 666 -268
Flags with carried forward coverage won't be shown. Click here to find out more. |
zregvart
changed the title
Member
|
Didn't test it, but I looked the commits - seems alright to me. |
lcarva
approved these changes
Apr 11, 2024
| * `name` (`string`) | ||
| * `namespace` (`string`) | ||
| * `qualifiers`(`array`) | ||
| **[object<key: string, value: string>] |
Contributor
There was a problem hiding this comment.
Does this need a space after ** ?
Contributor
Author
There was a problem hiding this comment.
It does, good catch
|
|
||
| - name: INFO | ||
| type: string | ||
| description: Include rule titles and descriptions in the output. Set to "false" to disable it. |
Contributor
There was a problem hiding this comment.
I think it should be "false". The value has to be a string.
Reference: EC-513
Create the `asciidoc` package and separate the command line reference documentation generation into the `asciidoc/cli` package. Reference: EC-513
This removes the builtin Rego documentation generation using the Antora extension. This will be replaced by go templating. Reference: EC-513
Reference: EC-513
Reference: EC-513
Reference: EC-513
Removes the Dependabot configuration for Antora extensions and the use of NPM in the release GitHub workflow. Reference: EC-513
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Reference: EC-513