Is the template a minor variation on an existing one? If so, please consider improving the existing template if possible.
Is the name of the template consistent with the examples already in the library, in style ("Noun - Verb"), layout and casing?
Are all parameters in the template consistent with the examples here, including help text documented with Markdown?
Is the description of the template complete, with correct Markdown?
Is the .json filename consistent with the name of the template?
Do scripts in the template validate required arguments and fail by returning a non-zero exit code when things go wrong?
Do scripts in the template produce worthwhile status messages as they execute?
Are you happy to contribute your template under the terms of the license? If you produced the template while working for your employer please obtain written permission from them before submitting it here.
Are the default values of parameters validly applicable in other user's environments? Don't use the default values as examples if the user will have to change them
For an example of how to test your step template script body before submitting a PR take a look at this gist
Before submitting your PR, please delete everything above the line below.
Adds the ability to create a snapshot file and compare that against a database using flyway.
Before
After
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
[x] If a new Category has been created:
[x] An image with the name {categoryname}.png must be present under the step-templates/logos folder
[x] The switch in the humanize function in gulpfile.babel.js must have a case statement corresponding to it
Step template guidelines
.jsonfilename consistent with the name of the template?Before submitting your PR, please delete everything above the line below.
Background
The new snapshot command can be found here: https://documentation.red-gate.com/fd/snapshot-184127462.html
The step has been updated to ignore "check.buildUrl" "check.buildUserName" and "check.BuildPassword" if the snapshot file path parameter is supplied.
These changes will allow users to replicate this functionality found here: https://github.com/red-gate/Flyway-Sample-Pipelines/blob/main/snapshotDriftCheck.sh
Results
Adds the ability to create a snapshot file and compare that against a database using flyway.
Before
After
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