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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 669251b9dfa65f885ae3d80db0ec59a073c65a121b924d7c23d771cf33faaa7d |
|
MD5 | 073aa2b9fbc98070cb3c331bef28068a |
|
BLAKE2b-256 | d14665f3b4cfb4bd8f82c410f6ecfee32e0ac2f4d7661c0e3a95a732db267af2 |
Hashes for pre_commit_gitlabci_lint-1.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e02d707d489f8b7fc410dc659714c13b8ef6efaaab1a8f2e77edeb87f62417f5 |
|
MD5 | 733ef7009b38e46034b6888342888c88 |
|
BLAKE2b-256 | 75cce69e42fb06992e5008d33b7691d3045f2844a9ada7ec3f2e385ddccd73d3 |