Introduction 🪨

Stoney is a Requirements-as-Code engine. It bridges the gap between your business requirements (Jira tickets) and your live system state.

Stoney allows you to define Contracts that run inside your GitHub Actions. These contracts verify that your environment is actually behaving as required.

Core Concepts

• Stateless: No database or infrastructure to manage for the runner.
• CI-Native: Designed specifically for GitHub Actions with PR commenting built-in.
• Requirement Mapping: Every check is linked to a requirement (req), making it clear why a test exists.

How it works

1. Suites: Collection of YAML files containing your contracts.
2. Contracts: Groupings of scenarios related to a specific feature.
3. Scenarios: The actual “Requirement” being tested.
4. Steps: The technical execution (HTTP, SQL, or Shell).