MRVA Report Documentation

Documentation for the Multi-Repository Variant Analysis (MRVA) reporting pipeline. This is a system that automates downloading, transforming, and visualizing CodeQL MRVA results into a single interactive report.

A live example is available at ghas-projects.github.io/mrva-deploy.

Reading the documentation

The published book is available at advanced-security.github.io/mrva-report-docs.

Building locally

Prerequisites

1. Install Rust
2. Install mdbook: cargo install mdbook
3. Install mdbook-mermaid: cargo install mdbook-mermaid
4. Install mdbook-asciinema: cargo install mdbook-asciinema

Preview

mdbook serve --open

Build

mdbook build

Output is written to the book/ directory.

Contributing

See CONTRIBUTING.md.

License

This project is licensed under the MIT License.