Reports Tab

[AleksandarCole]

Is your improvement proposal related to a problem? Please describe.

Currently, users who want to present structured information about their CI/CD pipelines are limited to standard job and workflow outputs. While logs and artifacts serve their purpose, there's an opportunity to provide users with a dedicated space to display custom, formatted content that's more accessible and readable than raw logs. This would enable users to create everything from structured deployment changelogs to test summaries, security scan reports, and various other custom outputs that would benefit from proper formatting and visualization.

Describe the solution you'd like

We propose adding a new "Report" tab to Job and Workflow pages that renders content from a job/workflow artifact called report/README.md. This feature would:

Display on both Job and Workflow pages
Render content from the report/README.md artifact (with proper security measures similar to GitHub's approach)
Include integration with Mermaid.js for rendering charts and diagrams
Show a helpful zero-state page with documentation links when report/README.md is not available
Be initially released behind a feature flag for controlled rollout

This would allow teams to create rich, formatted reports directly within the Semaphore interface, making information more accessible and enabling creative use cases beyond what's possible with standard job outputs.

Describe alternatives you've considered

• Using existing artifacts UI with no specialized rendering (less user-friendly, no markdown/diagram support)
• Creating specialized report types for specific use cases (less flexible than a general-purpose solution)
• Suggesting external tools for report generation (adds complexity to user workflows)
• Extending the logs UI with additional features (constrained by the linear nature of logs)

Additional context

UI design for the reports tab is available at: https://github.com/renderedtext/app-design/commit/87e22a0a759140f861d33e23976826ea128a820b

Example use cases for this feature include:

• Deployment changelogs with links to relevant tickets/PRs
• Security scan summaries with prioritized findings
• Resource usage visualization (CPU/Memory) at the job level
• Command duration analysis (pie charts showing time spent on different steps)
• Release notes generated during the build process

Implementation plan:

• Initial implementation behind feature flag
• Documentation page with usage examples (@TomFern can help with this)
• Create example scripts for generating useful reports:
  • Deployment changelog generators
  • Resource usage charts
  • Test summary formatters
  • Additional templates for common reporting needs