diff --git a/.github/workflows/check-artifact-changes.yml b/.github/workflows/check-artifact-changes.yml index ce4cb4b4ca0..cce6d8f799d 100644 --- a/.github/workflows/check-artifact-changes.yml +++ b/.github/workflows/check-artifact-changes.yml @@ -32,7 +32,7 @@ jobs: run: | echo "CI failure: Artifact changes checked in core/dbt/artifacts directory." echo "Files changed: ${{ steps.check_artifact_changes.outputs.artifacts_changed_files }}" - echo "To bypass this check, confirm that the change is not breaking (https://github.com/dbt-labs/dbt-core/blob/main/core/dbt/artifacts/README.md#breaking-changes) and add the 'artifact_minor_upgrade' label to the PR." + echo "To bypass this check, confirm that the change is not breaking (https://github.com/dbt-labs/dbt-core/blob/main/core/dbt/artifacts/README.md#breaking-changes) and add the 'artifact_minor_upgrade' label to the PR. Modifications and additions to all fields require updates to https://github.com/dbt-labs/dbt-jsonschema." exit 1 - name: CI check passed diff --git a/core/dbt/artifacts/README.md b/core/dbt/artifacts/README.md index 0cb2ea96e25..dd8990e28cd 100644 --- a/core/dbt/artifacts/README.md +++ b/core/dbt/artifacts/README.md @@ -29,6 +29,10 @@ All existing resources are defined under `dbt/artifacts/resources/v1`. ## Making changes to dbt/artifacts +### All changes + +All changes to any fields will require a manual update to [dbt-jsonschema](https://github.com/dbt-labs/dbt-jsonschema) to ensure live checking continues to work. + ### Non-breaking changes Freely make incremental, non-breaking changes in-place to the latest major version of any artifact (minor or patch bumps). The only changes that are fully forward and backward compatible are: