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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2648b148e6d57ecc5162423866efd450c7cf767cd085457855de32ee7cc2512 |
|
MD5 | aa9e27d7c1767c765cbf4aa2d7a41895 |
|
BLAKE2b-256 | 61d762e2dc4dbd9eae0e80672e17d09e38fa6eb39bf02fbd4726b926471763ed |
Hashes for pre_commit_gitlabci_lint-1.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbdaace3c400f5060c7ab235b90eed6010c693c41a2cda0eb16d864199af1087 |
|
MD5 | 4cf66a4efcf2eb6658f550342e06355b |
|
BLAKE2b-256 | 33559339f32b9ce451a7728f8c769faa89e2dd6bca08af4fce671e75cf783a47 |