Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create table of rules in README generated from metadata #36

Closed
anderseknert opened this issue Mar 1, 2023 · 0 comments · Fixed by #89
Closed

Create table of rules in README generated from metadata #36

anderseknert opened this issue Mar 1, 2023 · 0 comments · Fixed by #89

Comments

@anderseknert
Copy link
Member

While we could do this by hand, this is likely to get out of sync with the real world quickly. It should be fairly "easy" to create a Go utility, that scans metadata of all rules in the bundle directory and creates a markdown table for display. This table should include:

  • Category
  • Rule
  • Description
  • Enabled (by default)

The rule name should be a link pointing to the Styra docs for the rule.
anderseknert added a commit that referenced this issue Apr 12, 2023
@anderseknert
Add command for generating markdown table from rule annotations
a33f73b 
And generate a table for our README :)

NOTE: This should be integrated in the build, so that whenever a
built-in is added or updated, a new table is generated. I plan to
look into build-related improvements later, so doing this manually
for now.

Fixes #36

Signed-off-by: Anders Eknert <anders@styra.com>
@anderseknert anderseknert mentioned this issue Apr 12, 2023
Merged
anderseknert added a commit that referenced this issue Apr 12, 2023
@anderseknert
Add command for generating markdown table from rule annotations
73c77b4 
And generate a table for our README :)

NOTE: This should be integrated in the build, so that whenever a
built-in is added or updated, a new table is generated. I plan to
look into build-related improvements later, so doing this manually
for now.

Fixes #36

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit that referenced this issue Apr 12, 2023
@anderseknert
Add command for generating markdown table from rule annotations
e2cb256 
And generate a table for our README :)

NOTE: This should be integrated in the build, so that whenever a
built-in is added or updated, a new table is generated. I plan to
look into build-related improvements later, so doing this manually
for now.

Additionally, configure `gci` linter to group imports.

Fixes #36

Signed-off-by: Anders Eknert <anders@styra.com>
anderseknert added a commit that referenced this issue Apr 12, 2023
@anderseknert
Add command for generating markdown table from rule annotations (#89)
d2753f9 
And generate a table for our README :)

NOTE: This should be integrated in the build, so that whenever a
built-in is added or updated, a new table is generated. I plan to
look into build-related improvements later, so doing this manually
for now.

Additionally, configure `gci` linter to group imports.

Fixes #36

Signed-off-by: Anders Eknert <anders@styra.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add command for generating markdown table from rule annotations StyraInc/regal
1 participant
@anderseknert