docs: document alternative approach for local development #22
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: CI/CD | ||
| on: | ||
| <<<<<<< HEAD | ||
| workflow_dispatch: | ||
| push: | ||
| ======= | ||
| pull_request: # Runs whenever a pull request is created or updated (including from another fork) | ||
| push: # Runs whenever a commit is pushed to the repository... | ||
| branches: [experience-cs] # ...on any of these branches | ||
| workflow_dispatch: # Allows you to run this workflow manually from the Actions tab | ||
| >>>>>>> 657fd15d5 (Change CI to publish to GitHub package registry) | ||
| concurrency: | ||
| group: "${{ github.workflow }} @ ${{ github.head_ref || github.ref }}" | ||
| cancel-in-progress: true | ||
| permissions: | ||
| contents: write # publish a GitHub release | ||
| pages: write # deploy to GitHub Pages | ||
| issues: write # comment on released issues | ||
| pull-requests: write # comment on released pull requests | ||
| packages: write # deploy to GitHub Packages | ||
| jobs: | ||
| setup: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| DETECT_CHROMEDRIVER_VERSION: "true" | ||
| JEST_JUNIT_OUTPUT_DIR: test-results | ||
| NODE_OPTIONS: --max-old-space-size=4000 | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | ||
| - uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3 | ||
| with: | ||
| cache: "npm" | ||
| node-version-file: ".nvmrc" | ||
| registry-url: "https://npm.pkg.github.com" | ||
| - name: Info | ||
| run: | | ||
| cat <<EOF | ||
| Node version: $(node --version) | ||
| NPM version: $(npm --version) | ||
| GitHub ref: ${{ github.ref }} | ||
| GitHub head ref: ${{ github.head_ref }} | ||
| EOF | ||
| - name: Install Dependencies | ||
| run: npm ci | ||
| - name: Lint | ||
| run: npm run test:lint | ||
| - name: Cache node_modules | ||
| id: cache-nodemodules | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| node_modules | ||
| key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
| - name: Cache src/generated | ||
| id: cache-generated | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| src/generated | ||
| key: ${{ runner.os }}-generated-${{ hashFiles('package-lock.json') }} | ||
| - name: Cache static/microbit | ||
| id: cache-static | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| static/microbit | ||
| key: ${{ runner.os }}-microbit-${{ hashFiles('package-lock.json') }} | ||
| test-unit: | ||
| needs: setup | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| JEST_JUNIT_OUTPUT_NAME: unit-results.xml | ||
| JEST_JUNIT_OUTPUT_DIR: test-results/unit | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | ||
| - name: Cache NPM dependencies | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| node_modules | ||
| key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
| - name: Run Unit Tests | ||
| run: npm run test:unit -- --reporters="default" --reporters="jest-junit" --coverage --coverageReporters=text --coverageReporters=lcov --maxWorkers="2" | ||
| - name: Store Unit Test Results | ||
| uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3 | ||
| with: | ||
| name: unit-test-output | ||
| path: ./test-results/* | ||
| build: | ||
| needs: [setup, test-unit] | ||
| env: | ||
| NODE_OPTIONS: --max-old-space-size=4000 | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | ||
| - uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3 | ||
| with: | ||
| cache: "npm" | ||
| node-version-file: ".nvmrc" | ||
| - name: Retrieve node_modules | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| node_modules | ||
| key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
| - name: Retrieve src/generated | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| src/generated | ||
| key: ${{ runner.os }}-generated-${{ hashFiles('package-lock.json') }} | ||
| - name: Retireve static/microbit | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| static/microbit | ||
| key: ${{ runner.os }}-microbit-${{ hashFiles('package-lock.json') }} | ||
| - name: Run Build | ||
| env: | ||
| NODE_ENV: production | ||
| run: npm run build | ||
| - name: Cache Build Directory | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| ./build | ||
| key: ${{ runner.os }}-build-${{ hashFiles('package-lock.json') }} | ||
| - name: Cache Dist Directory | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| ./dist | ||
| key: ${{ runner.os }}-dist-${{ hashFiles('package-lock.json') }} | ||
| - name: Store Build Output | ||
| uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3 | ||
| with: | ||
| name: build-output | ||
| path: ./build | ||
| - name: Store Dist Output | ||
| uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3 | ||
| with: | ||
| name: dist-output | ||
| path: ./dist | ||
| test-integration: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| JEST_JUNIT_OUTPUT_NAME: results.txt | ||
| JEST_JUNIT_OUTPUT_DIR: test-results/integration | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | ||
| - name: Retrieve npm dependencies | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| node_modules | ||
| key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
| - name: Retrieve Build | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| ./build | ||
| key: ${{ runner.os }}-build-${{ hashFiles('package-lock.json') }} | ||
| - run: | | ||
| for F in chrome chromium chromedriver; do | ||
| which $F && $F --version || echo Not found: $F | ||
| done | ||
| - name: Run Integration Tests | ||
| run: npm run test:integration -- --reporters="default" --reporters="jest-junit" | ||
| - name: Store Integration Test Results | ||
| uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3 | ||
| with: | ||
| name: integration-test-output | ||
| path: ./test-results/* | ||
| deploy-npm: | ||
| needs: [test-integration, test-unit] | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | ||
| - name: Retrieve npm dependencies | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| node_modules | ||
| key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }} | ||
| - name: Retrieve Dist Directory | ||
| uses: actions/cache@e12d46a63a90f2fae62d114769bbf2a179198b5c # v3 | ||
| with: | ||
| path: | ||
| ./dist | ||
| key: ${{ runner.os }}-dist-${{ hashFiles('package-lock.json') }} | ||
| - run: | | ||
| if [[ ${{contains(github.ref, 'hotfix')}} ]]; then | ||
| sed -e "s|hotfix/REPLACE|${{ github.ref_name }}|" --in-place release.config.js | ||
| fi | ||
| - name: Publish to GitHub Packages | ||
| if: github.ref == 'refs/heads/experience-cs' | ||
| run: | | ||
| RELEASE_VERSION="0.1.0-experience-cs.$(date +'%Y%m%d%H%M%S')" | ||
| npm version --no-git-tag-version $RELEASE_VERSION | ||
| npm publish --access public --tag latest | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Deploy playground to GitHub Pages | ||
| uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: ./build | ||
| full_commit_message: "Build for ${{ github.sha }} ${{ github.event.head_commit.message }}" | ||
