example fails yaml validation

[boneskull]

Description:

The example in the README fails YAML schema validation in VSCode

Action version:

v5.0.0

Platform:

• Ubuntu
• macOS
• Windows

Runner type:

• Hosted
• Self-hosted

Repro steps:

1. Create a new labeler.yml in .github
2. Paste this (from the example):

   # Add 'source' label to any change to src files within the source dir EXCEPT for the docs sub-folder
   source:
   - all:
     - changed-files:
       - any-glob-to-any-file: 'src/**/*'
       - all-globs-to-all-files: '!src/docs/*'

3. See error:

Expected behavior:
No validation error

Actual behavior:
See screenshots

[HarithaVattikuti]

Hello @boneskull
Thank you for creating this issue. We will investigate it and get back to you as soon as we have some feedback.

[CRC-Mismatch]

This seems to be related to the schema published on https://json.schemastore.org/pull-request-labeler.json being out-of-date.

I'm not sure if that's the same one used by VSCode, but I can see the same validation failure in current Jetbrains IDEs, and they automatically fetch the schemas from there.

[boneskull]

To fix that, a PR should be created in the schemastore repo

[QuLogic]

I've written an updated schema that should be available already: https://json.schemastore.org/pull-request-labeler-5.json

I don't know whether VSCode actually uses those schemas though.

[hyperupcall]

I don't know whether VSCode actually uses those schemas though

VSCode itself won't with YAML files, but will do so with an extension, like the Red Hat YAML Extension

[CRC-Mismatch]

@QuLogic I think there's still something wrong with that schema... Or maybe with JetBrains' YAML validator. Either way, it's warning that the shorthand <label>: [ { changed-files: [ { ... } ] } ] way is wrong (I've shortened it, but it's using multi-line blocks in my case...

At least the verbose syntax works OK now (but too bad that I have to add a custom schema mapping to every project in order to use your schema 🥹 )

About VSCode, by itself it only validates the basic YAML syntax (AFAICR, maybe not even that), but it automatically offers "There are extensions in the marketplace for YAML!" the first time you open up one, and the top results will probably all validate using SchemaStore anyway 🤷‍♂️

[QuLogic]

That form is part of the tests, so if it's failing, it's not due to the schema.

[spock-yh]

This behavior seems to be a quirk of Intellij. It is solved if in the JSON schema one replaces oneOf with anyOf in the requirements of the Match object schema. Instead of:

      "oneOf": [
        { "required": ["changed-files"] },
        { "required": ["base-branch"] },
        { "required": ["head-branch"] }
      ],

Use:

      "anyOf": [
        { "required": ["changed-files"] },
        { "required": ["base-branch"] },
        { "required": ["head-branch"] }
      ],

There seem to be similar issues with oneOf with some validators, e.g. RicoSuter/NJsonSchema#1596.

Attaching a schema file that works in Intellij, you can add a schema mapping locally until this gets fixed in schemastore.org or in the validator.
pull-request-labeler-5-schema.json

[freeformz]

FWIW: This is a PITA

[chiranjib-swain]

Hi @boneskull ,
The error shown in the screenshots appears to be triggered by the RedHat YAML extension in VSCode, which applies a generic YAML schema. This schema doesn't account for the custom structure used by GitHub Actions' labeler configuration.
Please note that, despite the linter warning, the current configuration is valid for the labeler and should work as expected. If you do experience any issues with the labeler during workflow execution, feel free to share the details, and we’ll be happy to assist further.
Thanks!