Fix docs: Correction to Substitute Variables in Templates#3207
Draft
Rose-Northey wants to merge 3 commits into
Draft
Fix docs: Correction to Substitute Variables in Templates#3207Rose-Northey wants to merge 3 commits into
Rose-Northey wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the “Substitute variables in templates” documentation to reference the correct variable that controls whether variable-substitution failures fail a deployment, aligning the docs with current Calamari/Octopus behavior.
Changes:
- Updated the page to replace the incorrect variable (
Octopus.Action.Package.IgnoreVariableReplacementErrors) withOctopusShouldFailDeploymentOnSubstitutionFails. - Corrected the documented default behavior to indicate deployments do not fail by default on substitution failures.
- Updated the page
modDate.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Pull request environment is available at https://stoctodocspr3207.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
Rose-Northey
force-pushed
the
rosen/correct-variable-for-substitution-failures
branch
from
bda3e47 to
8a072ae
Compare
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
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.
The docs were referencing Octopus.Action.Package.IgnoreVariableReplacementErrors on the Substitute Variables in Templates page, but that variable belongs to the XML/structured config features. The correct variable for this feature is OctopusShouldFailDeploymentOnSubstitutionFails, introduced in Calamari PR #1430.
The default behavior was also originally documented incorrectly. It was corrected so the user expects a their deployment to succeed by default and only fail if the variable is added.
Fixes this linear issue