GitLab CI validation pre-commit-hook

This is a pre-commit hook that uses GitLab's /api/v4/ci/lint lint endpoint to validate the contents of .gitlab-ci.yml files. This is similar in fashion to how CircleCI pre-commit hooks validate that product's required configs, which is by uploading your config to an endpoint.

By default, this tool sends your configuration to https://gitlab.com, though this can be overridden (see below).

This tool has been extended and adapted from kadrach's implementation (cf. the license).

Usage

Requirements

GitLab Lint API now requires authorization.

1. Create Access Token with api scope.
2. Set access token value as GITLAB_TOKEN environment variable.
3. Ensure Python version available is 3.8 or later.

Warning Please note the token should not be shared and if leaked can cause significant harm.

Example

An example .pre-commit-config.yaml:

---
repos:
  - repo: https://github.com/bjd2385/pre-commit-gitlabci-lint
    rev: <latest release>
    hooks:
      - id: gitlabci-lint
      # args: ["https://custom.gitlab.host.com"]

Development

Install dependencies by running ./scripts/dependencies.sh. Or, if you already have yarn in your path, yarn install:deps.

Releases

Update src/gitlabci_lint/validate.py/__version__, setup.py/version-string, and tag this repo's master branch with the same version string (prefixed by 'v.)

TODOs:

[ ] Allow passing multiple config files for validation in template repositories. [ ]