Use this action to capture job-level evidence data in workflow runs for compliance and audit tracking. Navigate to Runs, select your run, and then view the evidence output in .
Prerequisites
Before you begin, ensure you have:
-
A CloudBees Unify workflow configured in your repository.
-
Job steps that generate compliance or audit data.
-
Understanding of your organization’s evidence requirements.
Action parameters
| Input name | Data type | Required? | Description |
|---|---|---|---|
|
String |
Yes |
The step level information captured as evidence for the workflow run. |
|
String |
No |
The markup language format. The default is Markdown. |
Basic usage
In your workflow YAML file, add:
- name: Publish workflow evidence item uses: cloudbees-io/publish-evidence-item@v1 with: content: |- ## example output - Run ID: ${{ cloudbees.run_id }} - [backend.tar](https://ourcompany.com/repo/backend.tar)
Advanced usage examples
Compliance evidence with build artifacts
- name: Publish build compliance evidence uses: cloudbees-io/publish-evidence-item@v1 with: content: | ## Build Compliance Report **Build Information:** - Build ID: ${{ cloudbees.run_id }} - Commit: ${{ github.sha }} - Branch: ${{ github.ref }} - Build Status: SUCCESS **Artifacts Generated:** - [Application Binary](https://artifacts.example.com/${{ cloudbees.run_id }}/app.tar.gz) - [Test Results](https://artifacts.example.com/${{ cloudbees.run_id }}/test-results.xml) - [Security Scan](https://artifacts.example.com/${{ cloudbees.run_id }}/security-report.json) **Quality Gates:** - Unit Tests: PASSED - Security Scan: PASSED - Code Coverage: 85% (Above threshold)
Deployment approval evidence
- name: Record deployment approval uses: cloudbees-io/publish-evidence-item@v1 with: content: | ## Deployment Approval Evidence **Approval Details:** - Approved by: ${{ vars.approver_name }} - Approval date: ${{ vars.approval_timestamp }} - Target environment: ${{ vars.target_environment }} **Pre-deployment Checklist:** - [ ] Security review completed - [ ] Performance testing passed - [ ] Rollback plan verified - [ ] Monitoring alerts configured
Markdown syntax support
This action supports system property references, such as ${{ cloudbees.run_id }} or ${{ vars.api_endpoint }}.
For complete Markdown syntax information, refer to the Markdown documentation.
| Markdown syntax | Supported? | Example | Rendered output | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Bulleted list |
|
|
|
||||||||
Character codes |
|
|
© | |
||||||||
Code |
|
|
|
||||||||
External content |
|
|
|||||||||
Formatting |
|
|
bold text |
||||||||
Headings |
|
|
|||||||||
HTML/Color |
|
||||||||||
Hyperlink |
|
|
|||||||||
Line break |
|
||||||||||
Quoted text (Blockquotes) |
|
|
A block quote of text such as this example.
— Anonymous
|
||||||||
Table |
|
|
|
Verify evidence items
After the workflow run completes, you can view evidence items in the workflow run details:
-
Navigate to Runs in CloudBees Unify.
-
Select your workflow run.
-
Navigate to to view all published evidence items.
Evidence items support audit trails, compliance reporting, and deployment approval workflows.
Troubleshooting
If evidence items are not displaying correctly:
-
Verify the
contentparameter contains valid Markdown syntax. -
Check that system property references use the correct format:
${{ cloudbees.property_name }}. -
Ensure the evidence publishing step completes successfully in your workflow.
-
Confirm you’re viewing the correct job in the run details.