docs: add use case for failing a pipeline on upload failures#24
Open
jthDEV wants to merge 1 commit into
Open
Conversation
ts-scan upload intentionally exits 0 on a failed transfer so a transient platform issue does not break CI/CD. Document how to react to a failed transfer when a missing SBOM is a real compliance gap, including the base-url pitfall behind "Missing Authentication Token".
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
1 participant
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.
Adds Use Case #4 – Fail a Pipeline on Upload Failures under Usage → Use Cases.
Why
ts-scan uploadintentionally exits with code0even when the transfer fails, so a transient platform issue doesn't break an otherwise green CI/CD pipeline. That's the right default, but it means a failed upload (and thus a missing SBOM in TrustSource) can go unnoticed. This use case documents how to opt into hard-failing where a missing SBOM is a real compliance gap.Contents
grepfor the failure marker to fail explicitly (shell + GitHub Actions snippets).Missing Authentication Tokenpitfall: it's an API Gateway unknown route response, usually caused by putting/v2in--base-url(ts-scan appends/v2/core/...itself).Changes
docs/uc04-failOnUploadFailure.mdmkdocs.yml🤖 Generated with Claude Code