Validate your GitLab CI with GitLab's API endpoint.
Project description
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.
- Create Access Token with
api
scope. - Set access token value as
GITLAB_TOKEN
environment variable. - 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. [ ]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pre-commit-gitlabci-lint-1.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44eee1cf7680d54a25529a3c39ac6c402a0dbd54e4a9e79e53dd7eb52974a6aa |
|
MD5 | 6687a060aaf6b9e5e93252175a006932 |
|
BLAKE2b-256 | c7fd32341f1774bbb4414b59bd43efadd3891a931509e44a7d4b061de4edd218 |
Hashes for pre_commit_gitlabci_lint-1.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 462febd78319c8574d24e775fe6d3bc832e23442054ccbc5817f0c18514fb3b0 |
|
MD5 | 8e5744064551cd2866ce0d731adb5654 |
|
BLAKE2b-256 | 8e5c63e8b323758b79a06d9e2cff1e8e2ad89899fd4cacd607c55af46b63ed1b |