Attaching Git metadata

The CLI can attach git metadata like branch, commit sha, owner and more when executing the test --record and deploy commands. This way you can keep track of your test sessions and deployed resources in the UI and cross-reference them with any updates to your code. For example, in the screenshot below we ran a test session from our CI server after the project was deployed to our Staging environment with the npx checkly test command.

After the test succeeds, we deploy this check so it runs as a monitor with npx checkly deploy.

Environment variables

The CLI will attempt to auto-detect and parse git specific information from your local machine or CI environment, but you can also set these data items specifically by using environment variables.

Item	Auto	Variable	Description
Repository	false	`repoUrl` in `checkly.config.ts` or `CHECKLY_REPO_URL`	The URL of your repo on GitHub, GitLab etc.
Commit hash	true	`CHECKLY_REPO_SHA`	The SHA of the commit.
Branch	true	`CHECKLY_REPO_BRANCH`	The branch name.
Commit owner	true	`CHECKLY_REPO_COMMIT_OWNER`	The committer’s name or email.
Commit message	true	`CHECKLY_REPO_COMMIT_MESSAGE`	The commit message.
Environment	false	`CHECKLY_TEST_ENVIRONMENT`	The environment name, e.g. “staging”

For example, if you want to specifically set the Environment you invoke:

Terminal

CHECKLY_TEST_ENVIRONMENT=Production npx checkly test

Or, if you want to set repo URL you invoke:

Terminal

CHECKLY_REPO_URL="https://my.git.solution/project/" npx checkly test

Working with multiple repositories

Each checkly test --record or checkly deploy run attaches one repository URL. If your checks live in more than one repository, for example a backend and a frontend repository, give each repository its own Checkly project: a checkly.config.ts with a unique logicalId and its own repoUrl.

checkly.config.ts

import { defineConfig } from 'checkly'

export default defineConfig({
  projectName: 'Backend monitoring',
  logicalId: 'backend-monitoring',
  repoUrl: 'https://github.com/acme/backend',
  /* More options... */
})

Do not deploy two repositories with the same logicalId. A deploy deletes the checks in the project that its code does not declare, so the second repository’s deploy removes the first one’s checks.

Getting Started

CLI Commands

Environment variables

Working with multiple repositories

​Environment variables

​Working with multiple repositories

Environment variables

Working with multiple repositories