`github-workflows-require-timeout` git hook

[ulgens]

I'm using the repository to check GHA files and one of the rules I need to validate is having timeout values.

I'm using pre-commit hooks as my entrypoint. While check-github-actions and check-github-workflows is covering the most with a simple hook definiton, timeout requirement needs a custom hook:

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

I tried to understand why this is the case and why there is no easy to use hook for timeout checks but I couldn't find much. It seems github-workflows-require-timeout defined under CUSTOM_SCHEMA_NAMES but as hooks,

- id: check-github-workflows
  entry: check-jsonschema --builtin-schema vendor.github-workflows
  files: ^\.github/workflows/[^/]+$
  ...

doesn't look that different compared to

- id: check-jsonschema
   files: ^\.github/workflows/[^/]+$
   args: ["--builtin-schema", "github-workflows-require-timeout"]

I think it would be nice to have an easy to use hook for require timeout check, instead of the current custom hook approach.

[sirosen]

👍 Thanks for filing the issue; I'm happy to add this!

---

Aside / random thoughts:

I have conflicted feelings about the github-workflows-require-timeout schema. It's the only builtin schema which isn't coming from SchemaStore. I can't recall, but I think that when I added it

1. I needed it myself
2. I thought there might be a growing family of such schemas

But then it wasn't clear what extra schemas to add, and it ended up being the only one.

So I "want" to remove it for no better reason than "tool purity", but it's super practical and useful. Since I have no intention of actually removing it, making a hook for it just makes it more usable.