GitLab CI .artifacts.reports.annotations is not supported

[dmytro-golovchenko-luminartech]

Issue:

Hook check-gitlab-ci is not able to handle .artifacts.reports.annotations because it is missing the schema

Explanation

1. GitLab doc is supporting it, see: https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsannotations
2. check-gitlab-ci is using schema from https://gitlab.com/gitlab-org/gitlab/-/raw/master/app/assets/javascripts/editor/schema/ci.json that is missing it

Steps to reproduce:

1. Create new git repo:

mkdir test-gitlab; cd test-gitlab; git init .

2. Setup check-gitlab-ci in pre-commit config. Create .pre-commit-config.yaml with a content below:

default_stages: [commit]
default_install_hook_types: [pre-commit, prepare-commit-msg]

repos:
  - repo: https://github.com/python-jsonschema/check-jsonschema
    rev: 0.28.4
    hooks:
      - id: check-gitlab-ci
        files: ^.*\.gitlab

3. Commit it

git add .pre-commit-config.yaml
git commit -a -m 'Add .pre-commit-config.yaml'

4. Install pre-commit:

pre-commit install

5. Add dummy GitLab job definition in .gitlab-ci.yml:

foo:
  stage: build
  tags:
    - bar
  script:
    - echo "test"
  artifacts:
    reports:
      annotations: upload_report.json

6. Try to commit changes in .gitlab-ci.yml, would get error like below:

git add .gitlab-ci.yml
git commit .gitlab-ci.yml -m 'Add .gitlab-ci.yml'

Output:

Validate GitLab CI config................................................Failed
- hook id: check-gitlab-ci
- exit code: 1

Schema validation errors were encountered.
  .gitlab-ci.yml::$.foo.artifacts.reports: Additional properties are not allowed ('annotations' was unexpected)

Reference

Filed issue on gitlab site: https://gitlab.com/gitlab-org/gitlab/-/issues/465876

[dmytro-golovchenko-luminartech]

https://gitlab.com/gitlab-org/gitlab/-/issues/465876 resolved by merge of https://gitlab.com/gitlab-org/gitlab/-/commit/673e420b2ac6c511193805369d530b64916e19c3, https://gitlab.com/gitlab-org/gitlab/-/raw/master/app/assets/javascripts/editor/schema/ci.json clearly includes annotations property for reports

However we are still getting same error in check-gitlab-ci as described above

Are we not pulling new (current) schema on pre-commit run or even install?

[sirosen]

I believe that this is just a matter of the vendored schema being older than the latest available from gitlab.

I'll make sure we're up to the latest and do a release, and then let you know about the new version. Expect me to come back here with another comment and close in just a few minutes. 🙂

[sirosen]

v0.29.2 is now out and should have the new schema. Please feel free to reopen or open a follow-up if it doesn't work for you!

(Also, I sort of skipped your question: because pre-commit.ci shuts off the network, and to get more consistent hook results, check-jsonschema vendors schema versions and doesn't fetch them dynamically. I want to get a more complete pipeline in place for vendoring and doing automatic releases, but I haven't been able to make time to work on it in a long time. Hopefully I'll get to it someday!)

[dmytro-golovchenko-luminartech]

confirming resolution and passing verification with version 0.29.2