Build information

The RelativeCI agent uses env-ci to read the necessary build information from the CI environment variables.

When the agents run on a supported CI service, the following environment information is automatically collected:

• slug (required) the repository slug
• service the CI service name
• branch (required) the commit's corresponding branch
• commit (required) commit SHA
• baseBranch the branch targeted by the the pull request(available in @relative-ci/agent@v5.1.0 and relative-ci/agent@3.1.0)
• pr pull request number
• build CI build number
• buildUrl CI build URL
• commitMessage commit message

Not supported CI services or non-CI environments

When the agent runs on a not-supported CI service or an environment that does not have access to the CI environment variables or git meta information, you need to provide the following environment variables:

Other environment variables

RELATIVE_CI_BRANCH="$(git rev-parse --abbrev-ref HEAD)"

RELATIVE_CI_COMMIT="$(git rev-parse --short HEAD)"

RELATIVE_CI_BASE_BRANCH="$(gh pr view --json baseRefName -q ".baseRefName")"

RELATIVE_CI_COMMIT_MESSAGE="$(git log -1 --pretty=%B)"

Docker example

from node:latest

## RelativeCI agent environment variables
ARG CI=true
ARG RELATIVE_CI_SERVICE="CI-SERVICE-container"
ARG RELATIVE_CI_SLUG
ARG RELATIVE_CI_KEY
ARG RELATIVE_CI_BRANCH
ARG RELATIVE_CI_PR
ARG RELATIVE_CI_BASE_BRANCH
ARG RELATIVE_CI_BUILD
ARG RELATIVE_CI_BUILD_URL
ARG RELATIVE_CI_COMMIT
ARG RELATIVE_CI_COMMIT_MESSAGE
ARG DEBUG

COPY . /app
WORKDIR /app

RUN npm install
RUN npm run build