docs(site): document signal tool Stage 3 exit semantics#876
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs(site): document signal tool Stage 3 exit semantics#876github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Add a 'Signal Tools' intro section before noop/missing-data/missing-tool/ report-incomplete that explains the critical behavioral differences operators need to know: - report-incomplete marks the build as Failed (exit 1) - noop/missing-tool succeed (or warn with issues if ADO unreachable) - missing-data always succeeds; no work item is filed - noop/missing-tool both file/append ADO work items by default The docs previously had no explanation of these exit semantics. Users choosing between the four tools had no way to know that report-incomplete causes a hard pipeline failure vs the others which succeed. The comparison table makes the choice clear. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
noop,missing-data,missing-tool, andreport-incompletenow have a clear comparison table explaining what each tool does to the Stage 3 pipeline resultreport-incompletefails the pipeline (exit 1) is now explicit — previously there was no indication of this vs the other three tools which succeedChanges
site/src/content/docs/reference/safe-outputs.mdx:noopheadingnoop/missing-toolwhen ADO credentials are unavailablereport-incompletedescription to clearly state it marks the build as Failed (exit 1)missing-datathat it has no front-matter configuration options, unlikenoopandmissing-toolAccuracy checks
src/safeoutputs/report_incomplete.rsexecute_impl(): returnsExecutionResult::failure(message)— confirmed failed exitsrc/safeoutputs/missing_data.rsexecute_impl(): returnsExecutionResult::success(message)— confirmed successful exit, no work item filingsrc/safeoutputs/noop.rsandsrc/safeoutputs/missing_tool.rs: both callfile_or_append_work_item()— confirmed work item behaviorsrc/safeoutputs/mod.rsfile_or_append_work_item(): returnsExecutionResult::warning()when ADO credentials absent — confirmed "Succeeded with Issues"src/main.rslines 619–626:failure_count > 0 → exit(1),warning_count > 0 → exit(2)— confirmed exit code semanticsValidation
cd site && npm ci && npm run build— 33 pages built, all internal links validCreated by the docs-writer workflow.