docs: add evidence transformation pipeline documentation#1
Open
cyrusagent[bot] wants to merge 1 commit intomainfrom
Open
docs: add evidence transformation pipeline documentation#1cyrusagent[bot] wants to merge 1 commit intomainfrom
cyrusagent[bot] wants to merge 1 commit intomainfrom
Conversation
79063b3 to
93c9550
Compare
Document how JUnit and Jacoco evidence types are transformed before being injected into the policy engine. This addresses issue chainloop-dev#2183 which requested documentation of the transformation process for non-JSON evidence types. The documentation covers: - Complete transformation pipeline architecture with flow diagram - JUnit XML transformation process and JSON output structure - Jacoco XML transformation process and coverage metrics - Policy engine integration via GetEvaluableContent function - Practical Rego policy examples for both evidence types - Guide for adding new evidence types to the system - Performance, security, and error handling considerations - Complete reference of key implementation files Signed-off-by: Cameron Banowsky <cameron@shebash.io>
93c9550 to
94cb3c9
Compare
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
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.
Summary
This PR adds comprehensive documentation explaining how JUnit and Jacoco evidence types are transformed before being injected into the policy engine. This addresses issue #2183.
Documentation Contents
The new documentation (
docs/evidence-transformation.md) covers:GetEvaluableContent()function and how materials are evaluatedImplementation Details
The documentation is based on thorough code analysis of:
/pkg/attestation/crafter/api/attestation/v1/crafting_state.go- Core transformation logic/pkg/attestation/crafter/materials/junit_xml.go- JUnit handler/pkg/attestation/crafter/materials/jacoco.go- Jacoco handler/pkg/policies/policies.go- Policy verification orchestratorValue
This documentation fills a gap identified by the maintainers and provides:
Closes chainloop-dev#2183