Add generateSchemas option #1781
Workflow file for this run
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
name: "Deploy Preview" | |
on: | |
pull_request_target: | |
branches: [main, v3.0.0, v2.0.0] | |
jobs: | |
precheck: | |
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }} | |
name: Precheck | |
runs-on: ubuntu-latest | |
permissions: | |
contents: read | |
security-events: write | |
outputs: | |
is-org-member-result: ${{ steps.is-org-member.outputs.is-org-member-result }} | |
steps: | |
- name: Check if actor is org member | |
id: is-org-member | |
run: echo "is-org-member-result=$(gh api -X GET orgs/PaloAltoNetworks/memberships/${{ github.actor }} | jq -r .message)" >> "$GITHUB_OUTPUT" | |
env: | |
GH_TOKEN: ${{ secrets.PAT }} | |
analyze: | |
if: github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && needs.precheck.outputs.is-org-member-result == 'null' | |
name: Analyze | |
needs: precheck | |
runs-on: ubuntu-latest | |
permissions: | |
contents: read | |
security-events: write | |
strategy: | |
fail-fast: true | |
matrix: | |
language: ["javascript"] | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
- name: Initialize CodeQL | |
uses: github/codeql-action/init@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3 | |
with: | |
languages: ${{ matrix.language }} | |
- name: Perform CodeQL Analysis | |
uses: github/codeql-action/analyze@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3 | |
analyze_unsafe: | |
if: github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && needs.precheck.outputs.is-org-member-result != 'null' | |
name: Analyze Unsafe | |
needs: precheck | |
runs-on: ubuntu-latest | |
environment: default | |
permissions: | |
contents: read | |
security-events: write | |
strategy: | |
fail-fast: true | |
matrix: | |
language: ["javascript"] | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
- name: Initialize CodeQL | |
uses: github/codeql-action/init@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3 | |
with: | |
languages: ${{ matrix.language }} | |
- name: Perform CodeQL Analysis | |
uses: github/codeql-action/analyze@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3 | |
build: | |
name: Build | |
needs: [analyze, analyze_unsafe] | |
if: | | |
github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && | |
!failure() && !cancelled() && | |
(success('analyze') || success('analyze_unsafe')) | |
runs-on: ubuntu-latest | |
permissions: | |
contents: read | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
- name: Setup node | |
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4 | |
with: | |
node-version: "20" | |
cache: "yarn" | |
- name: Install dependencies | |
run: yarn --prefer-offline | |
- name: Build packages | |
run: yarn build-packages | |
- name: Build site | |
run: yarn build-demo && zip -r build.zip demo/build | |
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 | |
with: | |
name: build | |
path: build.zip | |
deploy: | |
name: Deploy | |
needs: build | |
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && !failure() && !cancelled() }} | |
runs-on: ubuntu-latest | |
outputs: | |
preview_url: ${{ steps.deploy_preview.outputs.details_url }} | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
- name: Setup node | |
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4 | |
with: | |
node-version: "20" | |
cache: "yarn" | |
- uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4 | |
with: | |
name: build | |
- name: Unzip build artifact | |
run: unzip build.zip | |
- name: Deploy to Firebase | |
id: deploy_preview | |
uses: FirebaseExtended/action-hosting-deploy@0cbcac4740c2bfb00d632f0b863b57713124eb5a # v0.9.0 | |
with: | |
repoToken: "${{ secrets.GITHUB_TOKEN }}" | |
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PANDEV }}" | |
projectId: pandev | |
expires: 30d | |
channelId: "pr${{ github.event.number }}" | |
env: | |
FIREBASE_CLI_PREVIEWS: hostingchannels | |
visual_diff: | |
name: Visual Diff | |
needs: deploy | |
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && !failure() && !cancelled() }} | |
runs-on: ubuntu-latest | |
permissions: | |
contents: read | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
- name: Setup node | |
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4 | |
with: | |
node-version: "20" | |
cache: "yarn" | |
- name: Install dependencies | |
run: yarn --prefer-offline | |
- name: Install Playwright | |
run: npx playwright install --with-deps chromium | |
- name: Run visual diff | |
run: yarn ts-node scripts/sitemap-visual-diff.ts --preview-url ${{ needs.deploy.outputs.preview_url }} --summary-file visual_diffs/results.json --concurrency 4 --paths "/tests/" | |
- name: Generate report and summary | |
run: yarn ts-node scripts/generate-visual-diff-report.ts visual_diffs/results.json visual_diffs/index.html | |
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4 | |
if: always() | |
with: | |
name: visual_diffs | |
path: visual_diffs | |
- name: Comment PR with results | |
if: github.event_name == 'pull_request' || github.event_name == 'pull_request_target' | |
uses: actions/github-script@v7 | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
script: | | |
const fs = require('fs'); | |
const results = JSON.parse(fs.readFileSync('visual_diffs/results.json', 'utf8')); | |
const runUrl = `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`; | |
let body = `### Visual Diff Summary\n\n[View Logs](${runUrl})\n\n`; | |
body += `Total: ${results.summary.total}, Matches: ${results.summary.matches}, Diffs: ${results.summary.mismatches}, Skipped: ${results.summary.skipped}\n\n`; | |
if (results.pages.length) { | |
body += '| Page | Status |\n| --- | --- |\n'; | |
for (const p of results.pages) { | |
if (p.status !== 'match') { | |
body += `| ${p.path} | ${p.status} |\n`; | |
} | |
} | |
} | |
await github.rest.issues.createComment({ | |
...context.repo, | |
issue_number: context.issue.number, | |
body | |
}); |