Puppeteer Headful

Github Action for Puppeteer that can be ran "headful" or not headless.

Versioning of this container is based on the version of NodeJS in the container

Purpose

This container is available to Github Action because there is some situations ( mostly testing Chrome Extensions ) where you can not run Puppeteer in headless mode.

Usage

This installs Puppeteer ontop of a NodeJS container so you have access to run npm scripts using args. For this hook we hyjack the entrypoint of the Dockerfile so we can startup Xvfb before your testing starts.

name: CI
on: push
jobs:
  installDependencies:
    name: Install Dependencies
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Install Dependencies
      uses: actions/npm@master
      env:
        PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'true'
      with:
        args: install
    - name: Test Code
      uses: mujo-code/puppeteer-headful@master
      env:
        CI: 'true'
      with:
        args: npm test

Note: You will need to let Puppeteer know not to download Chromium. By setting the env of your install task to PUPPETEER_SKIP_CHROMIUM_DOWNLOAD = 'true' so it does not install conflicting versions of Chromium.

Then you will need to change the way you launch Puppeteer. We export out a nifty ENV variable PUPPETEER_EXEC_PATH that you set at your executablePath. This should be undefined locally so it should function perfectly fine locally and on the action.

browser = await puppeteer.launch({
  executablePath: process.env.PUPPETEER_EXEC_PATH, // set by docker container
  headless: false,
  ...
});