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

Complex Types - hbuildReleaseStreamType

  • Article
  • 2 minutes to read

Description

Information about a release stream for a product.

Properties

Name Type Occurrence Description
cdnTarget xs:anyURI Optional The name of a CDN target this release stream should sync to.
description xs:string Required Textual description for the release stream, helps to identify the purpose of the stream
fileOperation hbuildFileOperationType Optional
Array (0/∞)		 A list of file operations to perform
httpInvoke xs:string Optional An HTTP(S) URL that will be called using the GET method after the release has completed
id xs:anyURI Required Uniquely identifies the release stream, typically one of test, dev, beta or live
initialStatus hbuildPublishStatusType Required The status the stream is initially set to.
keepRevisions xs:unsignedInt Optional
Default=8		 Specifies the number of revisions to keep on this release stream. If not specified the default is 8. If you wish to keep all revisions then you should specify zero (0)
packageFileName xs:string Optional The name of the package that is used in the catalog
packageManager hbuildPackageManagerType Optional
Array (0/∞)		 A package manager publish operation. You can specify one or more package manager servers to deploy to
publishDependsOn hbuildStreamDependancyType Optional
Array (0/∞)		 The dependency on one ore more previously published streams
pushForward hbuildStreamPushType Optional Define this if you want to push forward to the next stream based on status change.
scpCopyFile hbuildScpCopyFileType Optional
Array (0/∞)		 One or more optional SCP copy operations to peform
sshRemoteExec hbuildSshRemoteExecType Optional
Array (0/∞)		 An SSH command to execute on the remote CDN system.
sshRemoteExec2 hbuildSshRemoteExec2Type Optional
Array (0/∞)		 Execute command(s) on a remote target
standstillPeriod xs:unsignedInt Optional
Default=48		 Specifies the number of hours to keep the build on this release stream. If not specified then default is 48 hours. If you do not want to enforce the standstill period then you should specify zero (0)
validation hbuildValidationTestType Optional Information about an expected post build validation test
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document