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

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{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 / Update

  • Article
  • 3 minutes to read

Operation Information

Hornbill Integration method for Updating a Release against a Team Foundation Server Release Pipeline.

See the Update API Documentation for more information: https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/update release?view=vsts-rest-tfs-4.1

Note: As per the Team Foundation Server API specification for updating Releases, you must provide either: a value for the keepForever input and/or a value for status input .

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 Microsoft Team Foundation Server.

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 Microsoft Team Foundation Server in the Type pick list;
  • Give the Microsoft Team Foundation Server KeySafe key a Title (this is the name / identifier for the Microsoft Team Foundation Server account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Server URL string Team Foundation Server URL
Collection string Team Foundation Server Collection
User ID string User ID of the User who owns the Personal Access Token
Personal Access Token string Personal Access Token used to authenticate the API calls

Revoking Access

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

Warning

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

Input Parameters

Display Name ID Type Description Required Supported Values
Project project string Project ID or project name. Yes None provided
Release ID releaseId string The ID of the Release you want to return Yes None provided
Keep Forever keepForever boolean Whether to exclude the release from retention policies. No None provided
Release Status status string Release Status No abandoned, active, draft, undefined
Artifacts artifacts array Sets list of artifact to update against a release No None provided
Comment comment string Sets the Comment No None provided
Description description string Sets the Description of the Release No None provided
Project Reference projectReference object Sets the Project Reference No None provided
Properties properties array Represents a property bag as a collection of key-value pairs. No None provided
Tags tags array Sets a list of Tags. No None provided
Variables variables array Sets the dictionary of variables. 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
Created By Name createdByName string Name of the user that created the Release
Created By ID createdById string ID of the user that created the Release
Created On createdOn string DateTime that the Release was created
Modified By Name modifiedByName string Name of the user that last modified the Release
Modified By ID modifiedById string ID of the user that modified the Release
Web URL modifiedOn string DateTime that the Release was last modified
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document