[components] Add workspace.yaml scaffolding (BUILD-652)

[smackesey]

Summary & Motivation

This adds workspace.yaml scaffolding to dg deployment scaffold and dg code-location scaffold. We will want to replace this in the future with whatever pyproject.toml-based replacement API we have in mind for workspace.yaml. But in the meantime, it makes sense to scaffold workspace.yaml.

• dg deployment scaffold will give you an empty workspace.yaml (except for some explanatory comments)
• dg code-location scaffold will modify the workspace.yaml, injecting the necessary entry for the code location to be loaded in its own environment by dagster dev

Caveats:

• The method of YAML modification wipes out comments-- workspace.yaml becomes a dg-managed file.

How I Tested These Changes

New unit tests.

[smackesey]

• [components] Add workspace.yaml scaffolding (BUILD-652) #27477 👈 (View in Graphite)
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-nmgd6t8i9-elementl.vercel.app

Direct link to changed pages:

• https://dagster-docs-nmgd6t8i9-elementl.vercel.app/guides/build/components/setting-up-a-deployment

[graphite-app]

Remove trailing whitespace after the # character to fix Vale linting error

Spotted by Graphite Reviewer (based on CI logs)

Is this helpful? React 👍 or 👎 to let us know.

[schrockn]

We should consider directly jumping to a pyproject.yaml-based approach IMO.

[schrockn]

dg code-location scaffold will modify the workspace.yaml, injecting the necessary entry for the code location to be loaded in its own environment by dagster dev

Requesting changes based on this, which I do not think we should support. Let's just add the capability to pyproject.toml

[smackesey]

Requesting changes based on this, which I do not think we should support. Let's just add the capability to pyproject.toml

Hmm ok. Thought I would need this for dg dev but am just generating a temporary workspace.yaml under the hood for now: #27481