docs update #28
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: Workflow | |
| on: push | |
| concurrency: | |
| group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}" | |
| cancel-in-progress: true | |
| jobs: | |
| prepare-environment: | |
| runs-on: ubuntu-latest | |
| name: Prepare environment | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 9 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: "pnpm" | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Cache node_modules | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: node_modules | |
| key: pnpm-${{ hashFiles('pnpm-lock.yaml') }} | |
| tests: | |
| name: Run tests | |
| runs-on: ubuntu-latest | |
| needs: prepare-environment | |
| timeout-minutes: 40 | |
| permissions: | |
| contents: read | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| test-group: ["core", "docusaurus"] | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 9 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: "pnpm" | |
| - name: Restore node_modules | |
| uses: actions/cache/restore@v4 | |
| id: cache-node-modules | |
| with: | |
| path: node_modules | |
| key: pnpm-${{ hashFiles('pnpm-lock.yaml') }} | |
| fail-on-cache-miss: false | |
| - name: Install dependencies on cache miss | |
| if: steps.cache-node-modules.outputs.cache-hit != 'true' | |
| run: pnpm install --frozen-lockfile | |
| - name: Build | |
| run: pnpm build | |
| - name: Typecheck | |
| run: pnpm --filter @docsgen/${{ matrix.test-group }} typecheck | |
| - name: Lint | |
| run: pnpm --filter @docsgen/${{ matrix.test-group }} lint | |
| - name: Test package | |
| run: pnpm --filter @docsgen/${{ matrix.test-group }} test:pipeline | |
| release: | |
| name: Release | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| runs-on: ubuntu-latest | |
| needs: tests | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 9 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: "pnpm" | |
| - name: Restore node_modules | |
| uses: actions/cache/restore@v4 | |
| id: cache-node-modules | |
| with: | |
| path: node_modules | |
| key: pnpm-${{ hashFiles('pnpm-lock.yaml') }} | |
| fail-on-cache-miss: false | |
| - name: Install dependencies on cache miss | |
| if: steps.cache-node-modules.outputs.cache-hit != 'true' | |
| run: pnpm install --frozen-lockfile | |
| - name: Build | |
| run: pnpm build | |
| - name: Publish | |
| run: pnpm release | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |