pre-commit and cookiecutter Poetry auto-generated GHA

[ghost]

Using Cookiecutter Poetry, I get some GHA which use an uses: ./.github/workflows/setup-poetry-env include. This is fine on GHA but pre-commit complains that:

Schema validation errors were encountered.
  .github/workflows/run-checks/action.yml::$: Additional properties are not allowed ('description', 'runs' were unexpected)
  .github/workflows/run-checks/action.yml::$: 'on' is a required property
  .github/workflows/run-checks/action.yml::$: 'jobs' is a required property
Schema validation errors were encountered.
  .github/workflows/setup-poetry-env/action.yml::$: Additional properties are not allowed ('description', 'inputs', 'runs' were unexpected)
  .github/workflows/setup-poetry-env/action.yml::$: 'on' is a required property
  .github/workflows/setup-poetry-env/action.yml::$: 'jobs' is a required property

Is there any way to exclude those files from pre-commit?

My pre-commit configuration is:

- repo: https://github.com/python-jsonschema/check-jsonschema
  rev: 0.16.1
  hooks:
  - id: check-jsonschema
    name: "Check GitHub Workflows"
    files: ^\.github/workflows/
    types: [yaml]
    args: ["--verbose", "--schemafile", "https://json.schemastore.org/github-workflow"]

[mondeja]

See exclude

[sirosen]

pre-commit excludes would definitely work. Strong 👍 to that for an immediate solution.

I would recommend trying a slightly different config:

- repo: https://github.com/python-jsonschema/check-jsonschema
  rev: 0.16.1
  hooks:
  - id: check-github-workflows
    args: ["--verbose"]

So that you use the vendored copy of the github-workflows schema. It would mean you don't get the latest schemastore schema at all times (so sometimes the vendored copy is a few commits behind schemastore), but it makes the hook behave more consistently. Changes on schemastore can't break your linting unexpectedly.

---

I'll take a look at the github workflows you're getting out of that project to see if maybe something is wrong with the hook config here, that it shouldn't be targeting those files. Or maybe there's something wrong with the upstream schema from schemastore. All of this when I get some more time to dig into this.

[ghost]

@mondeja

See exclude

Ah, thank you. This did the trick.

@sirosen I am not 100% sure that the cookiecutter YAML is valid. It runs fine… But that could be a side effect.

[sirosen]

I filed an issue with cookiecutter-poetry to suggest a change at that end. On this end of things, I think the match rule for github-workflows validation is not correct, and that it's not correct in schemastore either.

I'm going to try to remember to do some testing to confirm that, and then I'll see about changing schemastore and the github-workflows hook.

[sirosen]

I've just released v0.17.1 with a fix to the hook config that should make it no longer match on these files. If you're using exclude to avoid subdirs of the workflows dir, it should no longer be necessary.

I also have a related patch open on schemastore ( SchemaStore/schemastore#2344 ) to fix the match rule there, and the cookiecutter-poetry maintainer said he'll take up my suggested change when he's able. So I think this has surfaced a few little fixes and everything is on a good track now. 😄

Let me know if you see problems with v0.17.1!