Document need for care when deleting resources used by Git Runbooks#2628
Merged
steve-fenton-octopus merged 6 commits intomainfrom Feb 18, 2025
Merged
Conversation
steve-fenton-octopus
approved these changes
Feb 14, 2025
stevencl840
approved these changes
Feb 18, 2025
steve-fenton-octopus
deleted the
cat/103829/deleting-envs-required-by-cac
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background 🌵
When a user tries to delete an environment used by a DB Runbook, there are guardrails in place to prevent this. However with CaC Runbooks we can't maintain these guardrails as it's not practical to check every commit in a customer's repo to be sure there are no versions of their runbooks referencing a given environment.
There is a warning about this in the Unsupported Config as Code Scenarios page of the docs, but it's quite hidden away and we would like this info to be more readily available to CaC Runbooks users.
What's this?
This change just adds a couple of sentences to the CaC Runbooks doc warning against deleting required resources. And repeats a similar warning in the docs for channels, environments, lifecycles, tenant tags, worker pools and step templates.
What's it look like?
Fixes[sc-103829]
Fixes[sc-103789]