Library
Library copied to clipboard
Tothegills/for humans change example
Step template guidelines
- 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
.jsonfilename 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.
Background
Results
Before
After
Pre-requisites
- [ ]
Idshould be a GUID that is not00000000-0000-0000-0000-000000000000- NOTE If you are modifying an existing step template, please make sure that you do not modify the
Idproperty (updating theIdwill break the Library sync functionality in Octopus).
- NOTE If you are modifying an existing step template, please make sure that you do not modify the
- [ ]
Versionshould 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).
- [ ]
LastModifiedByfield must be present, and (optionally) updated with the correct author - [ ] The best practices documented here have been applied
- [ ] If a new
Categoryhas been created:- [ ] An image with the name
{categoryname}.pngmust be present under thestep-templates/logosfolder - [ ] The
switchin thehumanizefunction ingulpfile.babel.jsmust have acasestatement corresponding to it
- [ ] An image with the name
Fixes # . If there is an open issue that this PR fixes add it here, otherwise just remove this line
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.
:white_check_mark: tothegills
:x: Your Name
Your Name seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.