updating sandbox documentation (#240) #376
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 Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup pnpm | |
| uses: pnpm/action-setup@v4 | |
| with: | |
| version: 10.17.1 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 22 | |
| cache: pnpm | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Install dependencies | |
| run: pnpm install | |
| - name: Build packages | |
| run: pnpm -r run build | |
| - name: Download UX Studio artifacts | |
| run: | | |
| curl -fsSL https://sfcc-uxstudio.s3.amazonaws.com/uxstudio-4.5.tar.gz -o /tmp/uxstudio-4.5.tar.gz | |
| curl -fsSL https://sfcc-uxstudio.s3.amazonaws.com/uxstudio-4.6.tar.gz -o /tmp/uxstudio-4.6.tar.gz | |
| mkdir -p docs/public/uxstudio | |
| tar -xzf /tmp/uxstudio-4.5.tar.gz -C docs/public/uxstudio | |
| tar -xzf /tmp/uxstudio-4.6.tar.gz -C docs/public/uxstudio | |
| - name: Get latest release tag | |
| id: release | |
| run: | | |
| # Find the most recent package tag and docs tag by creation date. | |
| # This is safe because only @latest publishes and doc-only releases | |
| # trigger this workflow — maintenance patches on older minors are | |
| # excluded by the publish workflow gate. | |
| PKG_TAG=$(git tag --list '@salesforce/*' --sort=-creatordate | head -n1) | |
| DOCS_TAG=$(git tag --list 'docs@*' --sort=-creatordate | head -n1) | |
| # Pick whichever tag was created more recently | |
| LATEST_TAG="" | |
| if [[ -n "$PKG_TAG" && -n "$DOCS_TAG" ]]; then | |
| LATEST_TAG=$(git tag --list '@salesforce/*' --list 'docs@*' --sort=-creatordate | head -n1) | |
| elif [[ -n "$PKG_TAG" ]]; then | |
| LATEST_TAG="$PKG_TAG" | |
| elif [[ -n "$DOCS_TAG" ]]; then | |
| LATEST_TAG="$DOCS_TAG" | |
| fi | |
| echo "Latest package tag: ${PKG_TAG:-<none>}" | |
| echo "Latest docs tag: ${DOCS_TAG:-<none>}" | |
| echo "Building stable docs from: ${LATEST_TAG:-<none>}" | |
| echo "tag=$LATEST_TAG" >> $GITHUB_OUTPUT | |
| echo "exists=$([[ -n $LATEST_TAG ]] && echo true || echo false)" >> $GITHUB_OUTPUT | |
| - name: Build dev documentation | |
| run: | | |
| IS_DEV_BUILD=true pnpm run docs:build | |
| mv docs/.vitepress/dist docs/.vitepress/dist-dev | |
| - name: Build stable documentation from release tag | |
| if: steps.release.outputs.exists == 'true' | |
| run: | | |
| # Save config from main (has version dropdown and dynamic base path) | |
| cp docs/.vitepress/config.mts /tmp/config.mts | |
| # Remove S3-extracted uxstudio files before checkout to avoid conflicts | |
| # (older tags still have these files tracked in git) | |
| rm -rf docs/public/uxstudio | |
| # Checkout release tag | |
| git checkout ${{ steps.release.outputs.tag }} | |
| # Ensure UX Studio artifacts are present (older tags have them in git, | |
| # future tags won't — always extract from S3 to be safe) | |
| rm -rf docs/public/uxstudio | |
| mkdir -p docs/public/uxstudio | |
| tar -xzf /tmp/uxstudio-4.5.tar.gz -C docs/public/uxstudio | |
| tar -xzf /tmp/uxstudio-4.6.tar.gz -C docs/public/uxstudio | |
| # Restore config from main (has version dropdown and dynamic base path) | |
| cp /tmp/config.mts docs/.vitepress/config.mts | |
| # Build at release tag with main's config (no IS_DEV_BUILD = stable at root) | |
| pnpm install --frozen-lockfile | |
| pnpm -r run build | |
| pnpm run docs:build | |
| # Combine: stable at root, dev in /dev/ | |
| mv docs/.vitepress/dist-dev docs/.vitepress/dist/dev | |
| - name: Use dev as root when no release exists | |
| if: steps.release.outputs.exists != 'true' | |
| run: mv docs/.vitepress/dist-dev docs/.vitepress/dist | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/.vitepress/dist | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |