feat(preview): add experimental support for observing full documents #11883
This file contains 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: Create Documentation Report | |
| on: | |
| # Build on pushes branches that have a PR (including drafts) | |
| pull_request: | |
| # Build on commits pushed to branches without a PR if it's in the allowlist | |
| push: | |
| branches: [current, next] | |
| jobs: | |
| report: | |
| runs-on: ubuntu-latest | |
| env: | |
| TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} | |
| TURBO_TEAM: ${{ vars.TURBO_TEAM }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - uses: pnpm/action-setup@v4 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| run_install: false | |
| - name: Get pnpm store directory | |
| id: pnpm-cache | |
| shell: bash | |
| run: | | |
| echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT | |
| - name: Cache node modules | |
| id: cache-node-modules | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: cache-node-modules | |
| with: | |
| path: ${{ steps.pnpm-cache.outputs.STORE_PATH }} | |
| key: ${{ runner.os }}-pnpm-store-${{ env.cache-name }}-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| v1-${{ runner.os }}-pnpm-store-${{ env.cache-name }}- | |
| v1-${{ runner.os }}-pnpm-store- | |
| v1-${{ runner.os }}- | |
| - name: Install project dependencies | |
| run: pnpm install | |
| - name: Build packages | |
| run: pnpm build --output-logs=full --log-order=grouped | |
| env: | |
| NODE_OPTIONS: --max_old_space_size=8192 | |
| - name: Create Docs Report on current or next | |
| if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/current' || github.ref == 'refs/heads/next') }} | |
| env: | |
| DOCS_REPORT_TOKEN: ${{ secrets.DOCS_REPORT_DATASET_TOKEN }} | |
| DOCS_REPORT_DATASET: ${{ github.ref == 'refs/heads/current' && 'production' || 'next'}} | |
| run: pnpm docs:report:create | |
| - name: Create Docs Report on PR | |
| if: ${{ github.event_name == 'pull_request' }} | |
| env: | |
| DOCS_REPORT_TOKEN: ${{ secrets.DOCS_REPORT_DATASET_TOKEN }} | |
| DOCS_REPORT_DATASET: pr-${{ github.event.number }} | |
| run: pnpm docs:report:create | |
| - name: Compare Docs Coverage on PR | |
| if: ${{ github.event_name == 'pull_request' }} | |
| env: | |
| DOCS_REPORT_TOKEN: ${{ secrets.DOCS_REPORT_DATASET_TOKEN }} | |
| DOCS_REPORT_DATASET: pr-${{ github.event.number }} | |
| run: pnpm docs:report | |
| - name: PR comment with report | |
| uses: thollander/actions-comment-pull-request@fabd468d3a1a0b97feee5f6b9e499eab0dd903f6 # v2 | |
| if: ${{ github.event_name == 'pull_request' }} | |
| with: | |
| comment_tag: "docs-report" | |
| filePath: ${{ github.workspace }}/scripts/docs-report.md |