Skip to content

Adjust built in terraform step doc to better address git source use case#3074

Merged
tjnicholas merged 3 commits intomainfrom
timnicholas/terraform-steps-tweak
Mar 30, 2026
Merged

Adjust built in terraform step doc to better address git source use case#3074
tjnicholas merged 3 commits intomainfrom
timnicholas/terraform-steps-tweak

Conversation

@tjnicholas
Copy link
Copy Markdown
Contributor

The current version accidentally implies that variable replacement is only done with in-line and packaged files. Earlier, the document defines three potential template sources so listing two of three implies a distinction that does not exist. I think this is a hangover from before Octopus supported Git repositories as a source.

Rather than include the third (of three) source, it seems better to say that substitution is always applied.

Similarly, the potential for a Git source was missing from the statement about which files are substituted.

I note that the current statements are not technically incorrect (as I understand it git sources are essentially converted to packages internally) but the reader of this doc can't be expected to understand that detail.

Additionally, I have includes a sentence making it clear that the default substitution can be disabled.

Note ability to disable default substitution.

The previous version accientally implied that variable replacement is
only done with in-line and package files. I think this is a hangover
from before Octopus supported Git repositories as a source. Rather than
include the third third source, it seems better (assuming it is
accurate) to say that substitution is always applied.

Similarly, the potential for a Git source was missing from the statement
about which files are substitued.

Additionally, I have includes a line making it visible that the default
substitution can be disabled.
@tjnicholas
Copy link
Copy Markdown
Contributor Author

Linting errors addressed.

Copy link
Copy Markdown
Contributor

@flin-8 flin-8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tjnicholas tjnicholas merged commit b2bb911 into main Mar 30, 2026
5 checks passed
@tjnicholas tjnicholas deleted the timnicholas/terraform-steps-tweak branch March 30, 2026 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants