Repository navigation
Conversation
Add docs/soundness-api-breakage-check.md describing the `api-breakage-check` job in the Soundness workflow, alongside the existing docs-check documentation. The document covers: - How the job works: checkout settings, baseline selection (explicit baseline or the PR base branch), and how the allowlist and additional tool arguments are passed to `swift package diagnose-api-breaking-changes` - Requirements, including the need for a `pull_request` trigger unless `api_breakage_check_baseline` is set - A reference table of the `api_breakage_check_*` inputs - Common scenarios: release-tag baseline, allowlist, additional tool arguments, custom container image, and disabling the check - Troubleshooting for common failures
bkhouri
added this pull request to stack #326
October 16, 2026 06:21
FranzBusch
approved these changes
Oct 16, 2026
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
2 participants
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.
Add docs/soundness-api-breakage-check.md describing the
api-breakage-checkjob in the Soundness workflow, alongside the existing docs-check documentation.The document covers:
swift package diagnose-api-breaking-changespull_requesttrigger unlessapi_breakage_check_baselineis setapi_breakage_check_*inputs