Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.27 KB

README.md

File metadata and controls

77 lines (58 loc) · 3.27 KB

Outrigger cli

Docker image adding pa11y and other common tools to Docksal CLI.

GitHub tag Docker Stars Docker Pulls

This Docker image adds the following tools to the docksal/cli image:

DockerHub Integration

  • To generate new images for the latest Docksal version, add a new tag off master like 2.12
  • To enable more PHP versions like php7.4, go into DockerHub and add another automated build target:
    • Source Type: Tag
    • Source: ^[0-9.]+$
    • Docker Tag: {sourceref}-php7.4
    • Dockerfile Location: Dockerfile
    • Build Context: /
    • Autobuild: On
    • Build Caching: Off
  • DockerHub has automated builds configured to watch for new tags
  • It will match any tag with the pattern [0-9.]+ basically so we can keep up with Docksal's #.## versioning format
  • DockerHub uses hooks/build to override the CLI_VERSION value with the matched tag for each of the PHP versions in the automated builds list

Using pa11y with Docksal

In the project .docksal/docksal.env set the following:

CLI_IMAGE='outrigger/cli'

Then start your project with fin start. Once the containers have started, run the webpack-dev-server for your theme:

cd THEME_PATH
fin exec npm run theme

where the theme job is defined in package.json as:

scripts:
    "theme": "cross-env-shell NODE_ENV=development \"webpack-dev-server --config ./webpack.config.js --hot\"",

This will use your webpack config and enter watch mode to recompile when changes are detected to your theme files.

Once the theme has compiled and the webpack-dev-server is running, execute pa11y tests via:

fin exec npm run pa11y

where the pa11y job is defined in package.json as:

scripts:
  "pa11y": "pa11y-ci --config pa11y.js"

Resources

Security Reports

Please email [email protected] with security concerns.

Maintainers

Phase2 Logo