gitlab-dynamic-pipelines

Package for creating dynamic Gitlab CI/CD pipelines in TypeScript. Helpful if you want to create TypeScript objects that follow the GitLab CI/CD YAML Syntax Reference using TypeScript types.

Installation

npm install gitlab-dynamic-pipelines

Usage

Use these types to build a basic pipeline like this:

1import { writeFileSync } from 'node:fs';
2import { toYAML, Pipeline } from 'gitlab-dynamic-pipelines';
3
4const pipeline: Pipeline = {
5  globalKeywords: {
6    workflow: {
7      name: 'Basic Pipeline',
8    },
9    stages: ['test', 'build'],
10    default: {
11      image: 'node:18',
12    },
13  },
14  jobs: {
15    job1: {
16      stage: 'test',
17      image: 'node:20.12.2',
18      script: ['echo "it works!'],
19    },
20    job2: {
21      stage: 'build',
22      script: ['echo "it has been built!'],
23    },
24  },
25};
26
27writeFileSync('.gitlab-ci.yml', toYAML(pipeline));

Reference Tags

GitLab CI/CD Reference Tags can be created within scripts and variables using the included ReferenceTag class:

import { ReferenceTag } from 'gitlab-dynamic-pipelines';

myJob.before_script = [
  new ReferenceTag(['.something', 'before_script']),
  'my_script.sh',
];

Why are globalKeywords and jobs separated into two different sub-objects?

This is a limitation of TypeScript. As of this version, there is no way to define a type that has both known and unknown keys.