Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 24, 2025

Summary

Adds comprehensive documentation for using custom Rego rules with poutine, addressing #255 which requested clarification on how to write and use custom rules at runtime.

Changes

  • README.md: New "Custom Rules" section with configuration instructions, complete working example, and best practices
  • .poutine.sample.yml: Enhanced with detailed comments and examples for the include directive

Example Usage

  1. Create .poutine.yml:
include:
  - path: ./custom_rules
  1. Write a custom rule in ./custom_rules/my_rule.rego:
package rules.my_custom_rule
import data.poutine
import rego.v1

rule := poutine.rule(rego.metadata.chain())
results contains poutine.finding(rule, pkg.purl, {...}) if { ... }
  1. Run poutine:
poutine analyze_local .

Fixes #255

🤖 Generated with Claude Code

@fproulx-boostsecurity
Copy link
Contributor

Closes #363

@fproulx-boostsecurity fproulx-boostsecurity marked this pull request as ready for review October 24, 2025 16:34
@fproulx-boostsecurity fproulx-boostsecurity requested a review from a team as a code owner October 24, 2025 16:34
Copilot AI changed the title [WIP] Document usage of custom rego ruleset Document custom Rego ruleset support Oct 24, 2025
Document how to use custom Rego rules with poutine by:
- Adding a Custom Rules section to README.md with configuration
  instructions and a complete working example
- Enhancing .poutine.sample.yml with detailed comments and
  examples for the include directive

This addresses user requests for clarification on writing and
using custom rules at runtime.

Fixes #255

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@fproulx-boostsecurity fproulx-boostsecurity changed the title Document custom Rego ruleset support Add documentation for custom Rego rules Oct 24, 2025
@fproulx-boostsecurity fproulx-boostsecurity force-pushed the copilot/document-custom-rego-rules branch from ca05066 to d97a75c Compare October 24, 2025 16:57
@fproulx-boostsecurity fproulx-boostsecurity merged commit ba025b9 into main Oct 24, 2025
11 checks passed
@fproulx-boostsecurity fproulx-boostsecurity deleted the copilot/document-custom-rego-rules branch October 24, 2025 17:52
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.

Document / Support on using custom rego ruleset

3 participants