Skip to content

Feat: fixed promote underdocumentation#23

Open
niicommey01 wants to merge 1 commit into
flameiq:v2-devfrom
niicommey01:feat/fixed-promote-underdocumentation
Open

Feat: fixed promote underdocumentation#23
niicommey01 wants to merge 1 commit into
flameiq:v2-devfrom
niicommey01:feat/fixed-promote-underdocumentation

Conversation

@niicommey01

@niicommey01 niicommey01 commented Jun 5, 2026

Copy link
Copy Markdown

Feat: Add Exit Codes Documentation to Baseline Promotion Commands

Summary

This PR adds comprehensive exit codes documentation to the baseline promotion workflow for both v1 and v2 CLI commands.

Changes

Files Modified:

  • docs/source/cli/reference.rst — Added exit codes table to v1 flameiq baseline promote
  • docs/source/cli/v2_reference.rst — Added exit codes table to v2 flameiq v2 baseline promote

Exit Codes Documented:

  • 0 — Pass — all metrics within thresholds
  • 1 — Regression — threshold exceeded
  • 2 — Configuration or baseline error
  • 3 — Invalid or missing metrics file

Context

The baseline promote command was previously underdocumented regarding exit codes. This PR fills that gap by adding consistent exit code documentation to both the v1 and v2 reference guides, making it clear to users what each exit code means when promoting baselines.

Type

  • Documentation enhancement
  • No code changes

@niicommey01 niicommey01 marked this pull request as draft June 5, 2026 17:51
@niicommey01 niicommey01 changed the base branch from main to v2-dev June 5, 2026 17:53
@niicommey01 niicommey01 marked this pull request as ready for review June 5, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant