Skip to content

Updating template to use new(ish) ConnectionName parameter - #1702

Merged
harrisonmeister merged 1 commit into
masterfrom
update-mysql-execute
Aug 13, 2026
Merged

Updating template to use new(ish) ConnectionName parameter#1702
harrisonmeister merged 1 commit into
masterfrom
update-mysql-execute

Conversation

@twerthi

@twerthi twerthi commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Background

The PowerShell module, SimplySql, changed the commandlets to use a named connection, using Default as a default value. The finally statement in this template would always try to execute a close connection command. However, if the step failed before making a connection, the error was masked by the finally trying to close the Default connection when none existed. This update tests to make sure there is a connection before attempting to close it in the finally block.

Results

The template no longer masks the original error when no connection was established.

Before

The original error would get masked behind the error in the finally when attempting to close a connection when no connection was made.

After

finally block now tests to see if there is a connection before attempting to close it.

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
  • $Meta must have ExportedAt and OctopusVersion updated
  • 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

@github-actions

Copy link
Copy Markdown

Review this PR in Hyponome for a side-by-side diff of the step-template JSON and any embedded scripts.

@harrisonmeister harrisonmeister self-assigned this Aug 13, 2026

@harrisonmeister harrisonmeister left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@harrisonmeister
harrisonmeister merged commit ee3aa71 into master Aug 13, 2026
4 checks passed
@harrisonmeister
harrisonmeister deleted the update-mysql-execute branch August 13, 2026 17:57
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