Feat: fixed promote underdocumentation#23
Open
niicommey01 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 v1flameiq baseline promotedocs/source/cli/v2_reference.rst— Added exit codes table to v2flameiq v2 baseline promoteExit Codes Documented:
0— Pass — all metrics within thresholds1— Regression — threshold exceeded2— Configuration or baseline error3— Invalid or missing metrics fileContext
The
baseline promotecommand 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