Build time throw for Github Workflow schema

[Aplietexe]

When trying to use the GitHub Workflow schema from schemastore, an error is thrown at build time:

Error: Unprocessed keywords: ["properties"] at #/properties/on/oneOf/2/properties/branch_protection_rule

Perhaps it is because "properties" is present although branch_protection_rule is either an object or null. In any case, that is fine according to the metaschema, and seems to be a common practice to reduce duplication.

Example:

import { validator } from '@exodus/schemasafe'
// https://json.schemastore.org/github-workflow.json
import schema from './schema.js'

validator(schema)

schema.js simply export defaults the schema from the link.

[ChALkeR]

There is an option to silence schema mistakes: https://github.com/ExodusMovement/schemasafe/blob/master/doc/Options.md#options-for-relaxing-coherence-checks

Does the schema succeed in lax mode?
validator(schema, { allowUnusedKeywords: true }) (and validator(schema, { mode: 'lax' })) seems to pass, I re-checked.

[ChALkeR]

Ah. Upon a closer look, the mistake in the schema is a significant one!
This schema is invalid and doesn't do what it's supposed to do.

Consider the following parts of the schema you provided:

"$schema": "http://json-schema.org/draft-07/schema#",

            "branch_protection_rule": {
              "$comment": "https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#branch_protection_rule",
              "$ref": "#/definitions/eventObject",
              "description": "Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.",
              "properties": {
                "types": {
                  "$ref": "#/definitions/types",
                  "items": {
                    "type": "string",
                    "enum": ["created", "edited", "deleted"]
                  },
                  "default": ["created", "edited", "deleted"]
                }
              }

But in draft-07, unlike later ones, $ref makes all sibling keywords ignored: https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-01#section-8.3

Upstream testsuite: https://github.com/json-schema-org/JSON-Schema-Test-Suite/blob/8cdfac41e37527795879e480a483997cbd6188f3/tests/draft7/ref.json#L145-L177

[ChALkeR]

The proper fix is to update the schema version to "$schema": "https://json-schema.org/draft/2019-09/schema" or later, otherwise any compliant validator MUST ignore the sibling property keywords and those don't actually validate anything. Schemasafe just makes that mistake visible by default.

[ChALkeR]

@Aplietexe I reported this bug here: SchemaStore/schemastore#3102

[ChALkeR]

Closing as answered, this is a problem with schemastore schemas being incorrect (though technically valid, but not doing what they are intended to do).

This check can be silenced via options, but I wouldn't recommend that -- a proper way would be to actually fix the schema.

[ChALkeR]

A separate linter mode is introduced in 1.1.0/1.1.1