Skip to content

Render policy changelog in docs#30

Merged
puerco merged 1 commit into
mainfrom
update
Apr 14, 2026
Merged

Render policy changelog in docs#30
puerco merged 1 commit into
mainfrom
update

Conversation

@puerco

@puerco puerco commented Apr 14, 2026

Copy link
Copy Markdown
Member

This pull request enhances the documentation generation for policies by adding support for rendering changelogs at the policy set, group, and individual policy levels. It also updates the github.com/carabiner-dev/policy dependency to ensure compatibility with these changes.

Documentation improvements:

  • Added a writeChangelog function to render changelog entries in markdown tables, and integrated it into the writePolicySet, writePolicyGroup, and writePolicy functions to include changelogs in generated documentation. [1] [2] [3]

Dependency updates:

  • Updated github.com/carabiner-dev/policy to version v0.4.5 in go.mod to support changelog metadata.

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@carabiner.dev>
@puerco puerco merged commit ec53985 into main Apr 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant