Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow sensitive variables to be replaced with Octostache syntax when exporting a space #1546

Merged
merged 4 commits into from
Aug 19, 2024

Conversation

mcasperson
Copy link
Contributor

@mcasperson mcasperson commented Aug 13, 2024

Background

To support the migration of on-prem customers to the cloud, the serialize space to terraform step needs an additional option to allow the default value of sensitive variables to be replaced with Octostache references.

Results

This option exposes a new parameter on the step template to set default values.

Pre-requisites

  • Id should be a GUID that is not 00000000-0000-0000-0000-000000000000
    • NOTE If you are modifying an existing step template, please make sure that you do not modify the Id property (updating the Id will break the Library sync functionality in Octopus).
  • Version should be incremented, otherwise the integration with Octopus won't update the step template correctly
  • Parameter names should not start with $
  • Step template parameter names (the ones declared in the JSON, not the script body) should be prefixed with a namespace so that they are less likely to clash with other user-defined variables in Octopus (see this issue). For example, use an abbreviated name of the step template or the category of the step template).
  • LastModifiedBy field must be present, and (optionally) updated with the correct author
  • The best practices documented here have been applied
  • If a new Category has been created:
    • An image with the name {categoryname}.png must be present under the step-templates/logos folder
    • The switch in the humanize function in gulpfile.babel.js must have a case statement corresponding to it

Fixes # . If there is an open issue that this PR fixes add it here, otherwise just remove this line

Copy link

Review in hyponome

@mcasperson mcasperson enabled auto-merge (squash) August 13, 2024 22:17
@mcasperson mcasperson merged commit dee0fab into master Aug 19, 2024
3 checks passed
@mcasperson mcasperson deleted the mattc/sensitive_vars_replacement branch August 19, 2024 01:54
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