README.md

gitlab-pipeline-deleter

A Node.js CLI tool that deletes old GitLab CI pipelines.

Installation

$ npm install -g gitlab-pipeline-deleter

Usage

Usage: glpd [options] [gitlab-url] [project-id] [access-token]

Deletes old GitLab pipelines

Options:
  -d --days <days>  older than days (default: "30")
  --trace           show stack traces for errors when possible (default: false)
  -h, --help        display help for command

You can use either the command line arguments gitlab-url, project-id and access-token (the access-token needs to be owner of the project. See https://docs.gitlab.com/ee/api/pipelines.html#delete-a-pipeline for more information) or you can create a glpd.config.js configuration file that exports an object. Both CommonJS (.cjs) and ECMAScript Modules (.mjs) are supported. All of the command line arguments are supported but needs to be written in camelCase:

export default {
    gitlabUrl: 'https://example.com',
    projectId: '42',
    accessToken: '<my-token>',
    days: 30,
    trace: false,
};

If you specify command line arguments and a configuration file the command line arguments will overwrite the values in the configuration file. So the CLI arguments has always precedence.

Multiple project ids can be configured by providing a comma-separated list to the projectId argument.