Lint GitLab CI
A module and cli that lints a .gitlab-ci.yml
file, using the GitLab ci lint api.
Installing
npm install -g lint-gitlab-ci
Module
Basic usage
; lintGitlabCi.then;
Options
; ; lintGitlabCioptions.then;
Cli
Cli basic usage
lint-gitlab-ci
This will lint a .gitlab-ci.yml
file and output any errors.
Specify file
To specify a different ci file, pass the filename as an argument.
lint-gitlab-ci example-ci.yml
Cli options
-u, --url
Specifies the GitLab api url to use - defaults to https://gitlab.com/api
.
lint-gitlab-ci --url https://example.com/api
-a, --api-version
Specifies the GitLab api version to use - defaults to v4
.
lint-gitlab-ci --api-version exampleVersion
-p, --ci-lint-path
Specifies the GitLab api ci linting path to use - defaults to ci/lint
.
lint-gitlab-ci --ci-lint-path example/path
husky
Integration withInstall lint-gitlab-ci
and husky
.
npm install -D lint-gitlab-ci husky
Configure husky
to run the lint-gitlab-ci
cli before committing.
This will validate the current .gitlab-ci.yml
and block the commit if the file is invalid.
Credit
This project started as a TypeScript
implementation of this project, but is now a completely new implementation.