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: 📚🚀 Build documentation on release | |
| on: | |
| release: | |
| types: [published] | |
| workflow_dispatch: {} | |
| concurrency: | |
| group: docs-build-${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| name: Build Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup pnpm | |
| uses: pnpm/action-setup@v4 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: "package.json" | |
| cache: pnpm | |
| - name: Install deps | |
| run: pnpm install --prefer-offline --frozen-lockfile | |
| - name: Generate docs | |
| working-directory: docs | |
| env: | |
| APP_ENV: production | |
| run: pnpm run generate:docs | |
| - name: Pack generated docs (tarball) | |
| run: | | |
| tar -czf docs-generated.tgz -C docs generated-docs | |
| ls -lh docs-generated.tgz | |
| - name: Upload generated docs (tgz) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-generated-tgz | |
| path: docs-generated.tgz | |
| if-no-files-found: error | |
| - name: Upload versions file | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-versions | |
| path: docs/app/utils/versions.ts | |
| if-no-files-found: error | |
| deploy-docs-on-release: | |
| needs: [build-docs] | |
| name: Deploy Docs | |
| environment: | |
| name: docs-release | |
| url: ${{ steps.deploy.outputs.app_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download generated docs (tgz) | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs-generated-tgz | |
| path: . | |
| - name: Unpack generated docs into docs/ | |
| run: | | |
| set -euxo pipefail | |
| tar -xzf docs-generated.tgz -C docs | |
| ls -laR docs/generated-docs | sed -n '1,200p' | |
| - name: Download versions file | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs-versions | |
| path: docs/app/utils | |
| - uses: forge-42/[email protected] | |
| id: deploy | |
| env: | |
| FLY_ORG: ${{ vars.FLY_ORG }} | |
| FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} | |
| FLY_REGION: ${{ vars.FLY_REGION }} | |
| with: | |
| workspace_name: docs | |
| app_name: react-router-devtools-docs-release | |
| use_isolated_workspace: true | |
| env_vars: | | |
| APP_ENV=production | |
| GITHUB_OWNER=${{ github.repository_owner }} | |
| GITHUB_REPO=${{ github.event.repository.name }} | |
| GITHUB_REPO_URL=https://github.com/${{ github.repository }} |