Skip to content
alert-circle

GitHub Action

Checkly Trigger

v2.2.0 Latest version

Checkly Trigger

alert-circle

Checkly Trigger

CLI trigger for Checkly

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Checkly Trigger

              
  uses: tj-actions/[email protected]
Learn more about this action in tj-actions/checkly-trigger

Choose a version

CI Update release version. Public workflows that use this action.

checkly-trigger

CLI trigger for checkly.

...
    steps:
      - name: Checkly Trigger
        uses: tj-actions/checkly-trigger@v2
        with:
          trigger-url: ${{ secrets.TRIGGER_URL }}

Inputs

INPUT TYPE REQUIRED DEFAULT DESCRIPTION
deployment string false "false" Set to true to record
each trigger invocation as a
deployment event.
deployment-id string false The deployment id of your
triggered check, i.e. "deployment-1".
environment-name string false The environment name of your
triggered check, i.e. "production".
environment-url string false A staging or preview URL
injected as ENVIRONMENT_URL in browser
checks and auto-replaced in API
checks.
repository string false "${{ github.repository }}" Repository name, i.e. "checkly/backend-api".
run-location string false "us-east-1" An optional data center location
where to run your triggered
check. Use the shorter names
here, like eu-west-1 or us-west-1.
sha string false "${{ github.sha }}" Git hash, tag, version "v1.0.1"
or other identifier making this
deploy unique.
trigger-url string true The URL of the Checkly
trigger.

If you feel generous and want to show some extra appreciation:

Buy me a coffee

Credits

This package was created with Cookiecutter using cookiecutter-action

Report Bugs

Report bugs at https://github.com/tj-actions/checkly-trigger/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your workflow that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.