CircleCI schema does not allow a "machine" key in a "job" - disagrees with CircleCI docs

[jclerman]

Area with issue?

JSON Schema

✔️ Expected Behavior

I have a CircleCI config file in which I have jobs defined (in part) like:

jobs:
  my_job:
    machine:
      image: ubuntu-2004:2024.01.2
      docker_layer_caching: true

The current version of the CircleCI schema served at:
https://json.schemastore.org/circleciconfig.json

Does not allow that though - instead it wants a pre-defined (via an "exectors:" stanza) executor, and no longer allows the "machine:" key directly under a job definition.

This is in conflict with the current CircleCI docs, specifically the example shown here: https://circleci.com/docs/executor-intro/#linux-vm
and copied here:

jobs:
  build: # name of your job
    machine: # executor type
      image: ubuntu-2004:202010-01 # # recommended linux image - includes Ubuntu 20.04, docker 19.03.13, docker-compose 1.27.4

    steps:
        # Commands run in a Linux virtual machine environment

Consequently, I'm getting complaints from PyCharm, which is following the schema defined in this repo.

❌ Actual Behavior

PyCharm is flagging my CircleCI config as invalid, but it's working just fine at CircleCI.

YAML or JSON file that does not work.

Minimal example .circleci/config.yaml illustrating the problem:

version: 2.1

jobs:
  build:
    machine:
      image: ubuntu-2004:2024.01.2
      docker_layer_caching: true
    steps:
      - checkout
      - run: sudo apt-get update

 
workflows:
  build_and_deploy:
    jobs:
      - build:
          filters:
            tags:
              only: /.*/

IDE or code editor.

IntelliJ and it's derivatives

Are you making a PR for this?

No, someone else must create the PR.

[pieterocp]

Hey @jclerman from going through the changes from #3810 , I think that your scenario is covered and should now be marked as valid.

[jclerman]

@pieterocp agreed - my examples are validating now, as expected. Marking this issue closed.

[st11x]

@pieterocp agreed - my examples are validating now, as expected. Marking this issue closed.

@jclerman I'm using VSCode and this is still an issue for me. How do you get it to validate? Thanks.

[jclerman]

Actually this started failing for me again at some point after the issue was closed. I haven't tracked down the offending change. I'm using Pycharm, but I suspect that the IDE doesn't matter, it's the schema that has regressed.

[antonsmetanin]

I'm having the same issue. IntelliJ is complaining about a job not having the executor property, even though this should be allowed, and it works fine on CircleCI itself.

On a side note, I'm wondering why the schema can't be taken directly from here: https://github.com/CircleCI-Public/circleci-yaml-language-server/blob/main/schema.json

[pieterocp]

On a side note, I'm wondering why the schema can't be taken directly from here: https://github.com/CircleCI-Public/circleci-yaml-language-server/blob/main/schema.json

I think that this was originally committed on Dec 4, 2017 whereas the other was originally committed Nov 18, 2022, so they've been written in isolation. If the version in that project is better supported, it might be one to port in here, one to get buy-in from the contributors in there and in here.