Other CI platforms

Screenshotbot works on any CI framework.

On the following CI platforms, we can read the environment variables and determine most of the context we need to automatically generate reports:

• CircleCI
• Bitrise
• Netlify
• Azure DevOps
• Bitbucket Pipelines
• Buildkite
• Gitlab CI
• GitHub Actions
• TeamCity

If your CI is not listed above, please contact us and we can usually add it very quickly.

For some CI platforms such as Jenkins or Phabricator's Harbormaster, you might need to provide additional command line arguments manually. Here's a basic list of arguments that you might need to pass:

      --repo-url ...
      --build-url ... # optional
      --pull-request ... # URL of the pull request (except for Phabricator)
      --phabricator-diff-id ... # diff ID for Phabricator

GitHub Actions

GitHub Actions in particular needs a some careful configuration.

GitHub Actions treats Pull Requests differently, and we want to make sure that the job is run on the the main branch and your Pull Request. Using the check event might work, but Screenshotbot will be unaware of the Pull Request information which will result in an suboptimal review workflow. Instead, we recommend using pull_request with push events.

We also want to disable shallow clones by default.

      on:
        workflow_dispatch:
        pull_request:
        push:
          branches:
            - 'main'

      jobs:
        build:
          steps:
           - uses: actions/checkout@v3
             with:
               fetch-depth: 0