Skip to content

Fixing bug in sql-execute-sql-files.json#1531

Merged
harrisonmeister merged 1 commit intomasterfrom
update-sql-execute-script-files
Jul 15, 2024
Merged

Fixing bug in sql-execute-sql-files.json#1531
harrisonmeister merged 1 commit intomasterfrom
update-sql-execute-script-files

Conversation

@twerthi
Copy link
Copy Markdown
Contributor

@twerthi twerthi commented Jul 12, 2024


Background

The template contained a bug in the adding of a Hashtable key/value pair. Whenever a customer ticked the box to see verbose output, the code only contained the key and not the value which caused it to fail.

Results

Updated code to include the value in the .Add method call. No longer fails.

Before

Step template would fail due to logic error.

After

Step no longer fails.

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 issue reported by Mark Harrison

Copy link
Copy Markdown
Contributor

@harrisonmeister harrisonmeister left a comment

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 a491fb3 into master Jul 15, 2024
@harrisonmeister harrisonmeister deleted the update-sql-execute-script-files branch July 15, 2024 08:33
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