Skip to content

Commit

Permalink
EL-1694: Add puppeteer instructions to README (#1533)
Browse files Browse the repository at this point in the history
* EL-1694: Add puppeteer instructions to README
  • Loading branch information
HettieS authored Sep 11, 2024
1 parent dd2e4d1 commit 4321490
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,24 @@ The current values for these are available as secure notes in 1Password for each
although this could be a potential future option - the code we inherited from crime apply does have the capability of loading
a Portal metadata file from a URL.

## Manual Puppeteer upgrade

The application uses puppeteer as part of its testing pipeline - namely as part of the browser tools dockerfile. This is pinned to a specific puppeteer version, but because Chrome updates quite regularly, we have to manually update this when a new release comes out.

Here is an example PR of what the update looks like: https://github.com/ministryofjustice/laa-check-client-qualifies/pull/1482/files

Note we use a custom image inside browser tools dockerfile - when you create the branch with the puppeteer upgrade, you'll also need to add the branch name inside the YAML file that pushes the changes to Docker (`browser_tools_docker_image.yml`), and update the CircleCI config accordingly.

You can see our custom Docker image here - this will update once you've pushed a new image: https://hub.docker.com/r/checkclientqualifiesdocker/circleci-image/tags

Steps to follow are:

1. create an appropriately named branch referencing the puppeteer version upgrade i.e. `puppeteer-22**`
2. update Dockerfile_browser_tools.dockerfile & package.json with the new puppeteer version
3. run `yarn install` to update yarn.lock
4. add your branch name to .github/workflows/browser_tools_docker_image.yml so the new image gets pushed to Dockerhub
5. update .circleci/config.yml to reference the new image

## Branch naming

We name our branches to start with the Jira ticket ID, followed by a short description of the work.
Expand Down

0 comments on commit 4321490

Please sign in to comment.