From e992fffcf8588b96d24ea6491f41e087be1fea65 Mon Sep 17 00:00:00 2001
From: Teake Nutma <t.a.nutma@rug.nl>
Date: Tue, 5 Jul 2022 10:25:51 +0200
Subject: [PATCH] Add yml linting
With https://github.com/python-jsonschema/check-jsonschema/issues/112
check-jsonschema now works with !reference tags.
---
.gitlab-ci.yml | 26 ++++++++++++++------------
dockerfiles/ci-tools/Dockerfile | 1 +
dockerfiles/ci-tools/README.rst | 2 ++
3 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 8875166..eda5581 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,19 +1,21 @@
-# Note: there's no job to lint the .yml files, because:
-#
-# - The GitLab API for linting does not support local includes
-# and .extends is not fully supported [1].
-# - Local linting with e.g. check-jsonschema [2]
-# does not support GitLab's custom !reference tag [3] [4].
-#
-# [1] https://docs.gitlab.com/ee/api/lint.html#yaml-expansion
-# [2] https://github.com/python-jsonschema/check-jsonschema
-# [3] https://gitlab.com/gitlab-org/gitlab/-/issues/348666#note_804097628
-# [4] https://github.com/SchemaStore/schemastore/issues/1476
-
include:
- local: '/templates/shared/all.yml'
- local: '/templates/changedfiles/all.yml'
+lint:
+ stage: lint
+ # Note: the ci-tools image has to be build and pushed manually once to bootstrap this job
+ # since this job comes before the build_containers job.
+ image: ${CI_REGISTRY_IMAGE}/ci-tools:master
+ rules:
+ - !reference [.primary_ref_jobs, rules]
+ - !reference [.merge_request_jobs, rules]
+ script:
+ # Note: we cannot use the GitLab API https://docs.gitlab.com/ee/api/lint.html
+ # for this since that does not support local includes.
+ - shopt -s globstar dotglob
+ - check-jsonschema --data-transform gitlab-ci --builtin-schema vendor.gitlab-ci **/*.yml
+
build_containers:
stage: build
image:
diff --git a/dockerfiles/ci-tools/Dockerfile b/dockerfiles/ci-tools/Dockerfile
index d1b2b49..489159f 100644
--- a/dockerfiles/ci-tools/Dockerfile
+++ b/dockerfiles/ci-tools/Dockerfile
@@ -15,6 +15,7 @@ RUN apt-get update && apt-get -y install \
RUN pip install \
black==22.3.0 \
autopep8 \
+ check-jsonschema \
python-gitlab \
python-compare-ast \
coverage-fixpaths \
diff --git a/dockerfiles/ci-tools/README.rst b/dockerfiles/ci-tools/README.rst
index ef44f0f..13b5912 100644
--- a/dockerfiles/ci-tools/README.rst
+++ b/dockerfiles/ci-tools/README.rst
@@ -18,6 +18,7 @@ List of tools installed:
* `autopep8`_
* `release-cli`_
* `python-gitlab`_
+* `check-jsonschema`_
* `junitparser`_
* `anybadge`_
* `python-compare-ast`_
@@ -83,3 +84,4 @@ Usage:
.. _python-compare-ast: https://github.com/omegacen/python-compare-ast
.. _coverage-fixpaths: https://github.com/omegacen/coverage-fixpaths
.. _git-scripts: https://gitlab.astro-wise.org/omegacen/git-scripts
+.. _check-jsonschema: https://github.com/python-jsonschema/check-jsonschema
--
GitLab