This template uses a PowerShell module called SimplySql. The module has been updated to include the ability to specify a connection name. The finally statement attempts to ensure that all connections are closed, however, in cases where the connection was never established, the finally statement would fail and mask the original error. This PR adds the connection name as well as a test to see if the close statement needs to be called so the original error doesn't get buried.
Results
The added test will now expose the error that was encountered.
Before
If no connection was established due to an error, the finally statement would mask the error as it could not close.
After
The template now tests for a connection, if nothing was found, it will not attempt to close and expose the original error.
Pre-requisites
[X] 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).
[X] Version should be incremented, otherwise the integration with Octopus won't update the step template correctly
[X] Parameter names should not start with $
[X] 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).
[X] LastModifiedBy field must be present, and (optionally) updated with the correct author
[X] 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
Background
This template uses a PowerShell module called SimplySql. The module has been updated to include the ability to specify a
connection name. Thefinallystatement attempts to ensure that all connections are closed, however, in cases where the connection was never established, the finally statement would fail and mask the original error. This PR adds the connection name as well as a test to see if the close statement needs to be called so the original error doesn't get buried.Results
The added test will now expose the error that was encountered.
Before
If no connection was established due to an error, the finally statement would mask the error as it could not close.
After
The template now tests for a connection, if nothing was found, it will not attempt to close and expose the original error.
Pre-requisites
Idshould be a GUID that is not00000000-0000-0000-0000-000000000000Idproperty (updating theIdwill break the Library sync functionality in Octopus).Versionshould be incremented, otherwise the integration with Octopus won't update the step template correctly$LastModifiedByfield must be present, and (optionally) updated with the correct authorCategoryhas been created:{categoryname}.pngmust be present under thestep-templates/logosfolderswitchin thehumanizefunction ingulpfile.babel.jsmust have acasestatement corresponding to it