Docs/Guides: WordPress Playground for theme developers #5256
Workflow file for this run
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: CI | |
on: | |
push: | |
branches: | |
- trunk | |
pull_request: | |
jobs: | |
# This step: | |
# * Warms up the node_modules cache | |
# * Performs linting and typechecking | |
# | |
# The linting tasks take ~5s to complete and it doesn't | |
# make sense to separate them into separate steps that would | |
# take ~25s just to run git clone and restore node_modules. | |
lint-and-typecheck: | |
name: 'Lint and typecheck' | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ./.github/actions/prepare-playground | |
- run: npx nx affected --target=lint | |
- run: npx nx affected --target=typecheck | |
test-unit: | |
runs-on: ubuntu-latest | |
needs: [lint-and-typecheck] | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ./.github/actions/prepare-playground | |
- run: node --expose-gc node_modules/nx/bin/nx affected --target=test --configuration=ci | |
test-e2e: | |
runs-on: ubuntu-latest | |
needs: [lint-and-typecheck] | |
# Run as root to allow node to bind to port 80 | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ./.github/actions/prepare-playground | |
- run: sudo ./node_modules/.bin/cypress install --force | |
- run: sudo CYPRESS_CI=1 npx nx e2e playground-website --configuration=ci --verbose | |
# Upload the Cypress screenshots as artifacts if the job fails | |
- uses: actions/upload-artifact@v4 | |
if: ${{ failure() }} | |
with: | |
name: cypress-screenshots | |
path: dist/cypress/packages/playground/website/screenshots | |
build: | |
runs-on: ubuntu-latest | |
needs: [lint-and-typecheck] | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ./.github/actions/prepare-playground | |
- run: npx nx affected --target=build --parallel=3 --verbose | |
# Deploy documentation job | |
deploy_docs: | |
if: github.ref == 'refs/heads/trunk' && github.event_name == 'push' | |
# Add a dependency to the build job | |
needs: [test-unit, test-e2e, build] | |
name: 'Deploy doc site' | |
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
permissions: | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
# Deploy to the github-pages environment | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
# Specify runner + deployment step | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ./.github/actions/prepare-playground | |
- run: npm run build:docs | |
- uses: actions/upload-pages-artifact@v1 | |
with: { path: dist/docs/build } | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |