PrefectHQ / prefect

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.
https://prefect.io
Apache License 2.0
15.96k stars 1.57k forks source link

Update prefect.yaml formatter schema #12261

Open discdiver opened 6 months ago

discdiver commented 6 months ago

First check

Prefect Version

2.x

Describe the current behavior

Current schema is out of date

Describe the proposed behavior

Update @serinamarie's schema for recent prefect.yaml deployment changes at https://raw.githubusercontent.com/serinamarie/schemastore/add-prefect-dep-schema/src/schemas/json/prefect-deploy.json

Example Use

Steps to use

  1. Install a yaml extension - I recommend RedHat’s YAML extension (Hit the install button on the linked page or search for it in the Extensions tab of left nav in VS Code)
  2. Copy the schema Serina made into a file with a JSON extension (I’m putting mine into prefect-deploy.json in my hidden .vscode folder )
  3. Update your settings.json in VSCode with the path to the file like this: "yaml.schemas": { "file:///Users/jeffhale/.vscode/prefect-deploy.json": "prefect.yaml", You can open your settings.json from VSCode with cmd + p and type settings.json.
  4. Restart VS Code

Additional context

No response

discdiver commented 6 months ago

Requested by John Kang.

johnkangw commented 6 months ago

@discdiver Thanks!

serinamarie commented 5 months ago

This issue would requiring considering how we can keep the underlying schema updated in an automated way or it would quickly become outdated.