diff --git a/.github/workflows/docs-preview.yml b/.github/workflows/docs-preview.yml new file mode 100644 index 0000000..65ae16f --- /dev/null +++ b/.github/workflows/docs-preview.yml @@ -0,0 +1,63 @@ +name: Docs Preview +on: + pull_request_target: + branches: ["main"] +permissions: + contents: read + pages: write + id-token: write +concurrency: + group: "pages-preview @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}" + cancel-in-progress: false +jobs: + build: + permissions: + contents: read + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 + with: + ref: ${{ github.event.pull_request.head.ref }} + repository: ${{ github.event.pull_request.head.repo.full_name }} + fetch-depth: 0 + - name: Setup Pages + uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5 + + - uses: pnpm/action-setup@v4 + with: + version: latest + + - uses: actions/setup-node@v4 + with: + node-version: lts/* + cache: pnpm + + - name: Install & build + working-directory: docs + run: | + pnpm i + pnpm build + + - name: Upload artifact + uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3 + + deploy: + environment: + name: "Pages Preview" + url: ${{ steps.deployment.outputs.page_url }} + permissions: + contents: read + pages: write + id-token: write + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 + with: + preview: "true" + - name: Output to summary + run: | + echo 'Deployed preview to: ${{ steps.deployment.outputs.page_url }}' >> $GITHUB_STEP_SUMMARY diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 1ddcc00..2772845 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -63,3 +63,21 @@ jobs: - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action + + deploy-preview: + if: github.event_name == 'pull_request' && github.base_ref == 'main' + permissions: + contents: read + pages: write + id-token: write + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4 + with: + preview: "true" + - name: Output to summary + run: | + echo 'Deployed preview to: ${{ steps.deployment.outputs.page_url }}' >> $GITHUB_STEP_SUMMARY