Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.17 KB

File metadata and controls

57 lines (38 loc) · 1.17 KB

Rapid Security Review Runner

An extensible CLI to run automated checks for Eclipse Foundation Rapid Security Reviews.

Installation

uv tool install git+https://github.com/eclipse-csi/rsrr

Usage

Check results are printed as JSON to stdout.

# Run all checks
rsrr run [opts]

# Run specific checks
rsrr run --ef-project-id technology.csi -- ef_committers_count

# List available checks
rsrr list

Adding a new Check

Create a new file in src/rsrr/checks/ with a descriptive name, e.g. ultimate_answer.py, and add a Check implementation, e.g.

from .base import BaseCheck

class Check(BaseCheck):
    name = "Ultimate Answer"
    comment = "Get the answer to the Ultimate Question of Life"

    async def run(self) -> int:
        return 42

Browse existing checks/ for real-world examples.

Development

This project uses uv for project management, and just to run commands. Look up their docs for installation and usage instructions.

# List available commands (recipes)
just -l