Deployment Tasks
Task are used for executing deployments, or staging a deployment. Tasks can be assigned to any Domain. However, they are most commonly associated to Project Domains. You can assign a Task at a higher Domain level allowing any child Domains to automatically inherit the Tasks. This inheritance simplifies managing Tasks by making some common to all of your Subdomains. However, this means that a Catalog Domain may include Tasks that it cannot use.
The following Tasks are available as default Tasks, but you can create any type of custom Task. A custom Task will call a Custom Action:
- Deploy Version to Environment
- Manually Trigger Action to be executed
DeployHub Pro Calendars
DeployHub Pro includes a “smart” Calendar. The following Task are used to interact with the DeployHub Pro Smart Calendar for Requesting and Approving deployments.
- Request Calendar Entry for Deployment to an Environment
Adding, Editing and Deleting Tasks
You can add new Tasks from the Domain Dashboard by navigating to the Domain and interacting with the Tasks Section. Select the +Add option from the Tasks Section and a pop-up displays all available Tasks. Selecting a Task will add a new row into the table. Use the Task Detail Section to define the unique details of your new Task. You can update or remove a Task by using the Task Section table. Using the checkbox, select the item and use the the Delete or Edit options.
Once you create a Task, it is recommended that you rename that Task to more closely describe its use depending on the options selected.
Below is a description of all Tasks and their detailed information.
Deploy Version to Environment
Deploys an Application or Release version to an Environment. Select the target Environment via a drop-down list.
“Deploy” Task Detail Fields | Description |
---|---|
Name | The unique name of the Task. |
Created | Auto-generated date and time when added. |
Modified | Auto-generated date and time when updated. |
Pre-Action | Change the default behavior by assigning a custom Action to execute as a Pre-processing step. |
Post-Action | Change the default behavior by assigning a custom Action to execute as a Post-processing step. |
Available in Subdomains | If selected, all Subdomains will have access to this Task. |
Manually Trigger Action to be executed
Runs a stand-alone Action. For example, if you need to interrupt a deployment process, this Task allows you to execute the steps manually. The manually triggered Action will be placed in the “To do” list of the User or Group that executed the Deploy Task.
“Manually Trigger” Task Detail Fields | Description |
---|---|
Name | The name of the Task - can be changed to make the Task unique. |
Created | The auto generated date and time the Task was added. |
Modified | The auto generated date and time the Task was updated. |
Pre-Action | You can change the default behavior by assigning a custom Action to execute as a Pre-processing step. |
Post-Action | You can change the default behavior by assigning a custom Action to execute as a Post-processing step. |
Action to Run | The Action that will be executed manually. |
Available in Subdomains | If selected, all Subdomains will have access to this Task. |
Success Notify Template | The Notify Template that will be emailed on a successful Action. You will need to define the Notify Template from the Advanced Features Menu. See more on Notify Templates. |
Failure Notify Template | The Notify Template that will be emailed on a failed Action. You will need to define the Notify Template from the Advanced Features Menu. See more on Notify Templates. |
Task Execute Access
Once a Task is defined, it must be granted execute access to a Group before it can be invoked. Select the Task using the check box. Drag the desired Group from the Available Groups column to the Group Access area. Users of the Group can then execute the specified task.
Groups are assigned authority on a Task by Task basis. It is possible for a Domain to have two different Tasks with the same function, one of which allows a particular Group to run the Task, and the other which doesn’t. This allows similar Tasks to be created. They can have different characteristics assigned to them such as Pre-Actions and/or Post-Actions, Notification Templates, etc. Also different User Groups can have the authority to run them.
Additional Task Parameters
Additional parameters can be added to a Task. These additional parameters will set Global Variable at execution time. To add them, select the Task from the Task Section. Use +Add to create a new entry into the Parameters table for the selected task. It will have two columns:
-
Label: This will appear on the Task’s execution window whenever the Task is executed.
-
Variable: An Entry, Password, or Dropdown field appears to the right of the Label whenever a Task is executed, where values can be either entered or selected, depending on the Type.
Use the Save to commit the change to the table. Use Edit to update a Task Parameter, or Delete to remove a Task Parameter.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.