Skip to content

Save the task ID as an output variable - #1716

Merged
mcasperson merged 3 commits into
masterfrom
mattc/task_id_output
Oct 29, 2026
Merged

mcasperson merged 3 commits into
masterfrom
mattc/task_id_output

Conversation

@mcasperson

@mcasperson mcasperson commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Background

Save the Task ID as an output variable to allow it to be consumed to track the state of the task or get the logs.

Results

An output variable called TaskId is generated

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
  • $Meta must have ExportedAt and OctopusVersion updated
  • 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

@github-actions

Copy link
Copy Markdown

Review this PR in Hyponome for a side-by-side diff of the step-template JSON and any embedded scripts.

@mcasperson
mcasperson enabled auto-merge (squash) October 29, 2026 20:06

@twerthi twerthi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@mcasperson
mcasperson merged commit 1dffc09 into master Oct 29, 2026
3 checks passed
@mcasperson
mcasperson deleted the mattc/task_id_output branch October 29, 2026 20:27
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