diff --git a/.gitignore b/.gitignore index 99e1880..42cea1f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ zarf-package-* uds-bundle-* zarf-sbom +.vscode/ diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 0ff5ab7..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "yaml.schemas": { - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/v0.10.4/uds.schema.json": [ - "**/uds-bundle.yaml" - ], - - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/v0.10.4/tasks.schema.json": [ - "tasks.yaml", - "tasks/**/*.yaml", - "src/**/validate.yaml" - ], - "https://raw.githubusercontent.com/defenseunicorns/uds-cli/v0.10.4/zarf.schema.json": [ - "**zarf.yaml" - ] - }, - } diff --git a/README.md b/README.md index 792d56d..70e5773 100644 --- a/README.md +++ b/README.md @@ -99,3 +99,7 @@ Alternatively, you can deploy from OCI by running the following two commands: uds deploy swf-dev:0.2.2 ``` + +## Development + +When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the [guide](https://github.com/defenseunicorns/uds-common/blob/main/docs/development-ide-configuration.md) in uds-common.