This update adds additional options when calling the Jenkins /API endpoint that can be used to rate limit the Invoke-RestMethod calls. These calls fetch the URL for the build and depending on the Jenkins server load, may cause excessive consecutive calls while trying to get the build URL. There is also an added dimension of sleeping between calls.
Results
This change results in the option to have less calls to the jenkins /api endpoint while trying to get the build url, thus decreasing REST calls to the jenkins host.
Before
Number of calls prior the change
After
Number of calls after the change
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 update adds additional options when calling the Jenkins /API endpoint that can be used to rate limit the Invoke-RestMethod calls. These calls fetch the URL for the build and depending on the Jenkins server load, may cause excessive consecutive calls while trying to get the build URL. There is also an added dimension of sleeping between calls.
Results
This change results in the option to have less calls to the jenkins /api endpoint while trying to get the build url, thus decreasing REST calls to the jenkins host.
Before
Number of calls prior the change
After
Number of calls after the change
Pre-requisites
Id
should be a GUID that is not00000000-0000-0000-0000-000000000000
Id
property (updating theId
will break the Library sync functionality in Octopus).Version
should be incremented, otherwise the integration with Octopus won't update the step template correctly$
LastModifiedBy
field must be present, and (optionally) updated with the correct authorCategory
has been created:{categoryname}.png
must be present under thestep-templates/logos
folderswitch
in thehumanize
function ingulpfile.babel.js
must have acase
statement corresponding to it