gitlab-ci-variables
v0.1.0
Published
Provides typed access to GitLab CI environment variables.
Downloads
3,868
Readme
GitLab CI Variables
A package which parses the predefined variables set by GitLab CI, providing a structured object (with TypeScript definitions) representing the data from the environment.
Installation
npm install gitlab-ci-variables
Usage
import loadVariables, { isGitLabCI } from 'gitlab-ci-variables';
if (isGitLabCI()) {
console.log('Running under GitLab CI runner');
}
const variables = loadVariables();
// variables === undefined iff !isGitLabCI()
if (variables) {
console.log(`Build (ID ${variables.build.id}) of ${variables.project.name}. Started by ${variables.user.email}.`);
}
See the packaged TypeScript definitions for a full list of properties. Alternatively, see the Variables
interface in the source code.