Skip to content

Adding toggle and custom notes field for manual intervention auto approval#1535

Merged
domenicsim1 merged 5 commits intoOctopusDeploy:masterfrom
millerjn21:master
Aug 5, 2024
Merged

Adding toggle and custom notes field for manual intervention auto approval#1535
domenicsim1 merged 5 commits intoOctopusDeploy:masterfrom
millerjn21:master

Conversation

@millerjn21
Copy link
Copy Markdown
Contributor

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 .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.


Background

Results

Before

After

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 # . If there is an open issue that this PR fixes add it here, otherwise just remove this line

Copy link
Copy Markdown
Contributor

@domenicsim1 domenicsim1 left a comment

Choose a reason for hiding this comment

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

Request for CommunityActionTemplateId to be removed. This was most likely included from our export as its generated by Ocotpus when the step templated get added. Will look into removing it from export for the future.

Comment thread step-templates/run-octopus-runbook.json Outdated
Co-authored-by: domenicsim1 <87625140+domenicsim1@users.noreply.github.com>
@millerjn21
Copy link
Copy Markdown
Contributor Author

millerjn21 commented Jul 29, 2024

@domenicsim1 I committed your suggestion. Also you were correct, I created this by just creating a copy of the step template within Octopus, modifying, testing, then exporting. That is likely where it came from.

@domenicsim1 domenicsim1 merged commit 2561780 into OctopusDeploy:master Aug 5, 2024
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