Critical Journey Github Action

This GitHub Action runs the critical journey script inside a Docker container.

Inputs

• test_id: ID of the test to be run. Either this or test_suite_id should be provided.
• test_suite_id: ID of the test suite to be run.
• service_account_key: Your service account key to access fore ai Critical Journey.
• wait_timeout_seconds: (Optional) Maximum number of seconds to wait for the test to complete. Default is 300 seconds. Must be between 30 and 900 seconds (inclusive).
• website_url_override: (Optional) Allows overriding the base website URL used during test execution.
• variable_overrides: (Optional) Allows overriding test suite variables for this run. This should be a valid json string mapping each variable definition ID to an override object, e.g. { "0b5f...": { "kind": "non_secret", "value": "abc" } }.
• browser_type_override: (Optional) Browser engine to run the test with: 'chromium', 'firefox', or 'webkit'. Defaults to 'chromium' if not specified.
• create_issue_on_failure: (Optional) If true, automatically creates a GitHub issue when the test run fails. The issue includes step traces, error details, test configuration, and a screenshot from the last executed step. Requires GITHUB_TOKEN to be available. Default is false.
• fail_on_skipped: (Optional) If true, the action fails when any test in the run was skipped. Default is false.
• fail_on_not_runnable: (Optional) If true, the action fails when any test could not be run, e.g. because it is still generating. Default is true.

Cancelled and aborted runs always fail the action.

Outputs

• result: A message that includes information about the status of the run.

Example Usage for running a single test

name: Run CJ Github Action

on: [push]

jobs:
  my-job:
    runs-on: ubuntu-latest
    steps:
      - name: Run Test
        uses: foreai-co/cj-action@v1
        id: run_cj
        with:
          test_id: 'my-test-id'
          service_account_key: ${{ secrets.CRITICAL_JOURNEY_SERVICE_ACCOUNT_KEY }}
      
      - name: Print result
        run: echo "${{ steps.run_cj.outputs.result }}"

Example Usage for running a test suite

name: Run CJ Github Action

on: [push]

jobs:
  my-job:
    runs-on: ubuntu-latest
    steps:
      - name: Run Test Suite
        uses: foreai-co/cj-action@v1
        id: run_cj
        with:
          test_suite_id: 'my-test-suite-id'
          service_account_key: ${{ secrets.CRITICAL_JOURNEY_SERVICE_ACCOUNT_KEY }}
          wait_timeout_seconds: 360  # = 6 minutes
          # Override the website url using this optional field.
          website_url_override: 'https://beta-dev.my-awesome.com/2'
          # Override test parameters using this optional field. Provide valid json string.
          variable_overrides: '{ "3f2504e0-4f89-11d3-9a0c-0305e82c3301" : { "kind" : "non_secret", "value" : "value1" } }'

      - name: Print result
        run: echo "${{ steps.run_cj.outputs.result }}"

Example Usage with automatic GitHub issue creation on failure

When create_issue_on_failure is enabled, the action uses the default GITHUB_TOKEN provided automatically by GitHub Actions — no manual secret configuration required. If your repository uses restrictive default permissions, add issues: write to the job permissions.

name: Run CJ Github Action

on: [push]

jobs:
  my-job:
    runs-on: ubuntu-latest
    permissions:
      issues: write  # Required to create GitHub issues on failure
    steps:
      - name: Run Test Suite
        uses: foreai-co/cj-action@v1
        id: run_cj
        with:
          test_suite_id: 'my-test-suite-id'
          service_account_key: ${{ secrets.CRITICAL_JOURNEY_SERVICE_ACCOUNT_KEY }}
          create_issue_on_failure: 'true'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Print result
        run: echo "${{ steps.run_cj.outputs.result }}"