Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 469
ci(repo): dogfood snapi api checks#8621
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
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
741ad85
ci(repo): dogfood snapi api checks
jacekradko dd6e886
ci(repo): drop redundant snapi current-snapshot step
jacekradko 7b226d2
ci(repo): cache snapi baselines and watch @clerk/ui
jacekradko 14a0a3c
Merge branch 'main' into jacek/dogfood-snapi
jacekradko b54cb52
ci(repo): overlay HEAD's ui build wiring onto baseline worktree
jacekradko 41781d8
Revert "ci(repo): overlay HEAD's ui build wiring onto baseline worktree"
jacekradko 4454275
Merge branch 'main' into jacek/dogfood-snapi
jacekradko 139285a
ci(repo): use working-directory for baseline worktree steps
jacekradko 63fa1c8
ci(repo): fetch snapi from pkg.pr.new and pin baseline to base.sha
jacekradko adc1ce6
ci(repo): bump snapi to d3ee0217
jacekradko f7405d0
ci(repo): post snapi report as sticky PR comment
jacekradko efc6a97
Merge branch 'main' into jacek/dogfood-snapi
jacekradko 6cd5159
Merge branch 'main' into jacek/dogfood-snapi
jacekradko b3dc5bd
Merge branch 'main' into jacek/dogfood-snapi
jacekradko 8c173fa
ci(repo): opt @clerk/backend into snapi API analysis
jacekradko eb71790
ci(repo): add nextjs to snapi API analysis
jacekradko ec0e9d1
style(repo): format snapi.config.json
jacekradko a182d1c
Merge branch 'main' into jacek/dogfood-snapi
jacekradko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
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,2 @@ | ||
| --- | ||
| --- |
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,209 @@ | ||
| name: API Changes | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - release/v4 | ||
| - release/core-2 | ||
| paths: | ||
| - 'packages/backend/**' | ||
| - 'packages/clerk-js/**' | ||
| - 'packages/nextjs/**' | ||
| - 'packages/react/**' | ||
| - 'packages/shared/**' | ||
| - 'packages/ui/**' | ||
| - 'snapi.config.json' | ||
| - '.github/workflows/api-changes.yml' | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review] | ||
| branches: | ||
| - main | ||
| - release/v4 | ||
| - release/core-2 | ||
| paths: | ||
| - 'packages/backend/**' | ||
| - 'packages/clerk-js/**' | ||
| - 'packages/nextjs/**' | ||
| - 'packages/react/**' | ||
| - 'packages/shared/**' | ||
| - 'packages/ui/**' | ||
| - 'snapi.config.json' | ||
| - '.github/workflows/api-changes.yml' | ||
| permissions: | ||
| contents: read | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} | ||
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | ||
| env: | ||
| SNAPI_PACKAGE: https://pkg.pr.new/clerk/snapi/@clerk/snapi@d3ee0217f35a3b1ebb3ce73d252d12761b01f374 | ||
| SNAPI_FILTERS: >- | ||
| --filter=@clerk/backend | ||
| --filter=@clerk/clerk-js | ||
| --filter=@clerk/nextjs | ||
| --filter=@clerk/react | ||
| --filter=@clerk/shared | ||
| --filter=@clerk/ui | ||
| jobs: | ||
| publish-baseline: | ||
| if: github.event_name == 'push' | ||
| name: Publish API Baseline | ||
| runs-on: 'blacksmith-8vcpu-ubuntu-2204' | ||
| continue-on-error: true | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| timeout-minutes: ${{ vars.TIMEOUT_MINUTES_NORMAL && fromJSON(vars.TIMEOUT_MINUTES_NORMAL) || 10 }} | ||
| steps: | ||
| - name: Checkout Repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| filter: 'blob:none' | ||
| show-progress: false | ||
| - name: Setup | ||
| uses: ./.github/actions/init-blacksmith | ||
| with: | ||
| cache-enabled: true | ||
| turbo-signature: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }} | ||
| turbo-team: ${{ vars.TURBO_TEAM }} | ||
| turbo-token: ${{ secrets.TURBO_TOKEN }} | ||
| - name: Build declarations | ||
| run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS | ||
| - name: Generate API snapshot | ||
| run: | | ||
| pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \ | ||
| --output "$GITHUB_WORKSPACE/.api-snapshots-baseline" | ||
| - name: Save baseline to cache | ||
| uses: actions/cache/save@v4 | ||
| with: | ||
| path: .api-snapshots-baseline | ||
| key: snapi-baseline-${{ github.sha }} | ||
| check-api: | ||
| if: ${{ github.event_name == 'pull_request' && github.event.pull_request.draft == false }} | ||
| name: API Changes | ||
| runs-on: 'blacksmith-8vcpu-ubuntu-2204' | ||
| continue-on-error: true | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| defaults: | ||
| run: | ||
| shell: bash | ||
| timeout-minutes: ${{ vars.TIMEOUT_MINUTES_NORMAL && fromJSON(vars.TIMEOUT_MINUTES_NORMAL) || 10 }} | ||
| steps: | ||
| - name: Checkout Repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 100 | ||
| fetch-tags: false | ||
| filter: 'blob:none' | ||
| show-progress: false | ||
| - name: Setup | ||
| uses: ./.github/actions/init-blacksmith | ||
| with: | ||
| cache-enabled: true | ||
| turbo-signature: ${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }} | ||
| turbo-team: ${{ vars.TURBO_TEAM }} | ||
| turbo-token: ${{ secrets.TURBO_TOKEN }} | ||
| - name: Restore baseline from cache | ||
| id: baseline-cache | ||
| uses: actions/cache/restore@v4 | ||
| with: | ||
| path: .api-snapshots-baseline | ||
| key: snapi-baseline-${{ github.event.pull_request.base.sha }} | ||
coderabbitai[bot] marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| - name: Build current declarations | ||
| run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS | ||
| - name: Fetch base commit | ||
| if: steps.baseline-cache.outputs.cache-matched-key == '' | ||
| run: git fetch origin "${{ github.event.pull_request.base.sha }}" --depth=1 | ||
| - name: Create baseline worktree | ||
| if: steps.baseline-cache.outputs.cache-matched-key == '' | ||
| run: | | ||
| mkdir -p .worktrees | ||
| git worktree add --detach .worktrees/snapi-baseline "${{ github.event.pull_request.base.sha }}" | ||
| cp snapi.config.json .worktrees/snapi-baseline/snapi.config.json | ||
| - name: Install baseline dependencies | ||
| if: steps.baseline-cache.outputs.cache-matched-key == '' | ||
| working-directory: .worktrees/snapi-baseline | ||
| run: pnpm install --frozen-lockfile | ||
| - name: Build baseline declarations | ||
| if: steps.baseline-cache.outputs.cache-matched-key == '' | ||
| working-directory: .worktrees/snapi-baseline | ||
| run: pnpm turbo build:declarations $TURBO_ARGS $SNAPI_FILTERS | ||
| - name: Generate baseline API snapshots | ||
| if: steps.baseline-cache.outputs.cache-matched-key == '' | ||
| working-directory: .worktrees/snapi-baseline | ||
| run: | | ||
| pnpm dlx --package "$SNAPI_PACKAGE" snapi snapshot \ | ||
| --output "$GITHUB_WORKSPACE/.api-snapshots-baseline" | ||
| - name: Detect API changes | ||
| run: | | ||
| pnpm dlx --package "$SNAPI_PACKAGE" snapi detect \ | ||
| --baseline .api-snapshots-baseline \ | ||
| --output api-changes-report.md \ | ||
| --fail-on-breaking | ||
| - name: Upload API changes report | ||
| uses: actions/upload-artifact@v4 | ||
| if: always() | ||
| with: | ||
| name: api-changes-report | ||
| path: api-changes-report.md | ||
| if-no-files-found: ignore | ||
| retention-days: 5 | ||
| - name: Build snapi comment body | ||
| if: always() | ||
| id: report | ||
| run: | | ||
| if [ ! -f api-changes-report.md ]; then | ||
| exit 0 | ||
| fi | ||
| { | ||
| echo 'body<<SNAPI_REPORT_EOF' | ||
| echo '<!-- snapi-report -->' | ||
| if grep -q '## No API Changes Detected' api-changes-report.md; then | ||
| echo '**Snapi**: no API changes detected in `@clerk/backend`, `@clerk/clerk-js`, `@clerk/nextjs`, `@clerk/react`, `@clerk/shared`, `@clerk/ui`.' | ||
| else | ||
| cat api-changes-report.md | ||
| fi | ||
| echo 'SNAPI_REPORT_EOF' | ||
| } >> "$GITHUB_OUTPUT" | ||
| - name: Find existing snapi comment | ||
| if: always() && steps.report.outputs.body != '' | ||
| id: find-comment | ||
| uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e # v3.1.0 | ||
| with: | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| comment-author: 'github-actions[bot]' | ||
| body-includes: '<!-- snapi-report -->' | ||
| - name: Post snapi report | ||
| if: always() && steps.report.outputs.body != '' | ||
| uses: peter-evans/create-or-update-comment@23ff15729ef2fc348714a3bb66d2f655ca9066f2 # v3.1.0 | ||
| with: | ||
| comment-id: ${{ steps.find-comment.outputs.comment-id }} | ||
| issue-number: ${{ github.event.pull_request.number }} | ||
| body: ${{ steps.report.outputs.body }} | ||
| edit-mode: replace | ||
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,14 @@ | ||
| { | ||
| "packages": [ | ||
| "packages/backend", | ||
| "packages/clerk-js", | ||
| "packages/nextjs", | ||
| "packages/react", | ||
| "packages/shared", | ||
| "packages/ui" | ||
| ], | ||
| "snapshotDir": ".api-snapshots", | ||
| "mainBranch": "main", | ||
| "checkVersionBump": true, | ||
| "outputFormat": "markdown" | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.