Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Releases / Create

  • Article
  • 3 minutes to read

Operation Information

Hornbill Integration method for creating a Release against an Azure DevOps Project Release Pipeline.

See the Create API Documentation for more information: https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/create?view=azure-devops-rest-5.0.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Azure DevOps.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Azure DevOps in the Type pick list;
  • Give the Azure DevOps KeySafe key a Title (this is the name / identifier for the Azure DevOps account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Azure DevOps account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Organization Name organization string The name of the Azure DevOps organization. Yes None provided
Project project string Project ID or project name. Yes None provided
Artifacts artifacts array Sets list of artifact to create a release No None provided
Definition ID definitionId number Release Definition ID Yes None provided
Description description string Sets the Description of the Release No None provided
Environments Metadata environmentsMetadata array Sets list of environments meta data. No None provided
Is Draft isDraft boolean Should the Release be created as a Draft? No None provided
Manual Environments manualEnvironments array Sets list of environments to manual as condition. No None provided
Properties properties array Represents a property bag as a collection of key-value pairs. No None provided
Reason reason string Release Reason No continuousIntegration, manual, none, pullRequest, schedule
Variables variables array Sets list of release variables to be overridden at deployment time. No None provided

Output Parameters

Display Name ID Type Description
ID id string Release ID
Name name string Release Name
Reason reason string Release Reason
Status status string Release Status
API URL apiUrl string API URL
Web URL webUrl string Web URL
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document