html2canvas/.github/workflows/ci.yml

name: CI

on:
  push:
    branches: [ master ]
    tags:
      - 'v*'
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest
    name: Build
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Npm install
        run: npm ci
      - name: Build
        run: npm run build
      - name: Pack
        run: |
          npm pack
          mv html2canvas-*.tgz html2canvas.tgz
          tar --list --verbose --file=html2canvas.tgz
      - name: Upload npm pack
        uses: actions/upload-artifact@v2
        with:
          name: npm
          path: html2canvas.tgz
          if-no-files-found: error
      - name: Upload dist
        uses: actions/upload-artifact@v2
        with:
          name: dist
          path: dist
          if-no-files-found: error
      - name: Upload build
        uses: actions/upload-artifact@v2
        with:
          name: build
          path: build
          if-no-files-found: error

  test:
    runs-on: ubuntu-latest
    name: Test
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Npm install
        run: npm ci
      - name: Build
        run: npm run build
      - name: Lint
        run: npm run lint
      - name: Unit tests
        run: npm run unittest
  browser-test:
    strategy:
      fail-fast: false
      matrix:
        config:
          - os: ubuntu-latest
            name: Linux Firefox Stable
            targetBrowser: Firefox_Stable
            xvfb: true
          - os: ubuntu-latest
            name: Linux Chrome Stable
            targetBrowser: Chrome_Stable
            xvfb: true
          - os: macos-latest
            name: OSX Safari Stable
            targetBrowser: Safari_Stable
          - os: macos-latest
            name: iOS Simulator Safari 12
            targetBrowser: Safari_IOS_12
            xcode: /Applications/Xcode_10.3.app
          - os: macos-latest
            name: iOS Simulator Safari 13
            targetBrowser: Safari_IOS_13
            xcode: /Applications/Xcode_11.6_beta.app
          - os: macos-latest
            name: iOS Simulator Safari 14
            targetBrowser: Safari_IOS_14
            xcode: /Applications/Xcode_12_beta.app
          - os: macos-11
            name: iOS Simulator Safari 15
            targetBrowser: Safari_IOS_15
            xcode: /Applications/Xcode_13.0.app
          - os: windows-latest
            name: Windows Internet Explorer 9 (Emulated)
            targetBrowser: IE_9
          - os: windows-latest
            name: Windows Internet Explorer 10 (Emulated)
            targetBrowser: IE_10
          - os: windows-latest
            name: Windows Internet Explorer 11
            targetBrowser: IE_11
    runs-on: ${{ matrix.config.os }}
    name: ${{ matrix.config.name }}
    env:
      TARGET_BROWSER: ${{ matrix.config.targetBrowser }}
    needs: build
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Npm install
        run: npm ci
      - name: Download library
        uses: actions/download-artifact@v2
        with:
          name: dist
          path: dist
      - name: Download test-runner
        uses: actions/download-artifact@v2
        with:
          name: build
          path: build
      - name: xcode selection
        if: ${{ matrix.config.xcode != '' }}
        run: sudo xcode-select -s "${{ matrix.config.xcode }}"
      - name: Run browser tests
        if: ${{ matrix.config.xvfb != true }}
        run: npm run karma
      - name: Start Xvfb
        if: ${{ matrix.config.xvfb == true }}
        run: Xvfb :99 &
      - name: Run browser tests
        if: ${{ matrix.config.xvfb == true }}
        run: DISPLAY=:99 npm run karma
      - name: Upload screenshots
        uses: actions/upload-artifact@v2
        with:
          name: reftest-results
          path: tmp/reftests
          if-no-files-found: error
  publish:
    runs-on: ubuntu-latest
    name: Publish
    if: startsWith(github.ref, 'refs/tags/v')
    needs: browser-test
    steps:
      - uses: actions/checkout@v2
      - name: Download NPM package
        uses: actions/download-artifact@v2
        with:
          name: npm
          path: npm
      - name: Download library
        uses: actions/download-artifact@v2
        with:
          name: dist
          path: dist
      - name: Create Github Release
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ github.ref }}
          release_name: ${{ github.ref }}
          draft: false
          prerelease: ${{ contains(github.ref, '-rc.') || contains(github.ref, '-alpha.') }}
      - name: Upload html2canvas.js
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./dist/html2canvas.js
          asset_name: html2canvas.js
          asset_content_type: text/javascript
      - name: Upload html2canvas.min.js
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./dist/html2canvas.min.js
          asset_name: html2canvas.min.js
          asset_content_type: text/javascript
      - name: Upload html2canvas.esm.js
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./dist/html2canvas.esm.js
          asset_name: html2canvas.esm.js
          asset_content_type: text/javascript
      - name: Unpack npm
        run: cd npm && tar -xvzf "html2canvas.tgz"
      - uses: actions/setup-node@v1
        with:
          node-version: 12
          registry-url: 'https://registry.npmjs.org'
      - name: NPM Publish
        run: cd npm/package && npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
  docs:
    runs-on: ubuntu-latest
    name: Build docs
    needs: browser-test
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Npm install
        run: npm ci
      - name: Download library
        uses: actions/download-artifact@v2
        with:
          name: dist
          path: www/static/dist
      - name: Download test results
        uses: actions/download-artifact@v2
        with:
          name: reftest-results
          path: www/static/results
      - name: Copy reftests to docs website
        run: cp -R tests/reftests www/static/tests/reftests && cp -R tests/assets www/static/tests/assets && cp tests/test.js www/static/tests/test.js
      - name: Create reftest result index
        run: npm run build:reftest-result-list www/static/results/metadata www/src/results.json
      - name: Create reftest previewer
        run: npm run build:reftest-preview
      - name: Clean metadata folder
        run: rm -rf www/static/results/metadata
      - name: Build docs
        run: npm run build && cd www && npm install && npm run build && cd ..
      - name: Upload docs
        uses: actions/upload-artifact@v2
        with:
          name: docs
          path: www/public
          if-no-files-found: error
  publish-docs:
    runs-on: ubuntu-latest
    name: Publish Docs
    if: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v') }}
    needs: docs
    steps:
      - uses: actions/checkout@v2
        with:
          persist-credentials: false
      - name: Download docs
        uses: actions/download-artifact@v2
        with:
          name: docs
          path: docs
      - name: Publish docs
        uses: JamesIves/github-pages-deploy-action@3.7.1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: docs
          SINGLE_COMMIT: true
          CLEAN: true
  diff-reftests:
    runs-on: ubuntu-latest
    name: Diff reftest screenshots
    needs: browser-test
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Cache node modules
        uses: actions/cache@v2
        env:
          cache-name: cache-node-modules
        with:
          # npm cache files are stored in `~/.npm` on Linux/macOS
          path: ~/.npm
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-build-${{ env.cache-name }}-
            ${{ runner.os }}-build-
            ${{ runner.os }}-
      - name: Npm install
        run: npm ci
      - name: Checkout current snapshots
        run: git checkout origin/gh-pages results
      - name: Download test results
        uses: actions/download-artifact@v2
        with:
          name: reftest-results
          path: tmp/reftests
      - name: Run diff
        run: npm run reftests-diff
        continue-on-error: true
      - name: Upload diff
        uses: actions/upload-artifact@v2
        with:
          name: snapshot-diffs
          path: tmp/snapshot-diffs