-
Notifications
You must be signed in to change notification settings - Fork 0
ci(SP-4166): add reusable schema sync check workflow #5
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.
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
Open
isasmendiagus
wants to merge
1
commit into
main
Choose a base branch
from
feat/SP-4166/schema-sync-ci
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| name: Schema Sync Check | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| source-file: | ||
| description: 'Path to the schema file in this repo' | ||
| required: true | ||
| type: string | ||
| target-file: | ||
| description: 'Path to the vendored schema file in the consumer repo' | ||
| required: true | ||
| type: string | ||
| fail-on-diff: | ||
| description: 'Fail the workflow when schemas are out of sync' | ||
| required: false | ||
| type: boolean | ||
| default: true | ||
|
|
||
| jobs: | ||
| check-schema-sync: | ||
| name: Check Schema Sync | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout consumer repo | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Checkout schema repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: ${{ github.repository_owner }}/schema | ||
| path: .schema-source | ||
|
|
||
| - name: Compare schemas | ||
| id: compare | ||
| shell: bash | ||
| run: | | ||
| source_path=".schema-source/${{ inputs.source-file }}" | ||
| target_path="${{ inputs.target-file }}" | ||
|
|
||
| if [ ! -f "$source_path" ]; then | ||
| echo "::error::Source schema not found: ${{ inputs.source-file }}" | ||
| exit 1 | ||
| fi | ||
|
|
||
| if [ ! -f "$target_path" ]; then | ||
| echo "::error::Local vendored schema not found: $target_path" | ||
| exit 1 | ||
| fi | ||
|
|
||
| if diff -u "$source_path" "$target_path"; then | ||
| echo "Schema is in sync." | ||
| else | ||
| echo "" | ||
| echo "::error::Schema out of sync: $target_path" | ||
| echo "" | ||
| echo "To fix, run:" | ||
| echo " curl -sL https://raw.githubusercontent.com/${{ github.repository_owner }}/schema/main/${{ inputs.source-file }} -o $target_path" | ||
| echo "result=out-of-sync" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| - name: Report result | ||
| if: steps.compare.outputs.result == 'out-of-sync' | ||
| run: | | ||
| msg="Vendored schema is out of sync with ${{ github.repository_owner }}/schema. See diff above." | ||
| if [ "${{ inputs.fail-on-diff }}" = "true" ]; then | ||
| echo "::error::${msg}" | ||
| exit 1 | ||
| else | ||
| echo "::warning::${msg}" | ||
| fi | ||
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.
Uh oh!
There was an error while loading. Please reload this page.