Skip to content

Allow passing --breakage-allowlist-path to the API breakage check #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FranzBusch merged 1 commit into from
Nov 20, 2024
Merged

Allow passing --breakage-allowlist-path to the API breakage check #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion .github/workflows/soundness.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ on:
type: boolean
description: "Boolean to enable the API breakage check job. Defaults to true."
default: true
api_breakage_check_allowlist_path:
type: string
description: "Path to a file that will be passed as --breakage-allowlist-path to swift package diagnose-api-breaking-changes"
default: ""
api_breakage_check_container_image:
type: string
description: "Container image for the API breakage check job. Defaults to latest Swift Ubuntu image."
Expand Down Expand Up @@ -89,7 +93,11 @@ jobs:
- name: Run API breakage check
run: |
git fetch ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY} ${GITHUB_BASE_REF}:pull-base-ref
swift package diagnose-api-breaking-changes pull-base-ref
if [[ -z '${{ inputs.api_breakage_check_allowlist_path }}' ]]; then
swift package diagnose-api-breaking-changes pull-base-ref
else
swift package diagnose-api-breaking-changes pull-base-ref --breakage-allowlist-path '${{ inputs.api_breakage_check_allowlist_path }}'
fi

docs-check:
name: Documentation check
Expand Down Expand Up @@ -217,6 +225,7 @@ jobs:
curl -s https://raw.githubusercontent.com/swiftlang/github-workflows/refs/heads/main/.github/workflows/configs/yamllint.yml > .yamllint.yml
fi
yamllint --strict --config-file .yamllint.yml .

python-lint-check:
name: Python lint check
if: ${{ inputs.python_lint_check_enabled }}
Expand Down