Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - hbuildReleaseStreamType

Description

Information about a release stream for a product.

Properties

Name Type Occurrence Description
id xs:anyURI Required Uniquely identifies the release stream, typically one of test, dev, beta or live
description xs:string Required Textual description for the release stream, helps to identify the purpose of the stream
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
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)
onStandstillElapsed hbuildStandstillActionType Optional
Default=wait
What the controller does when the standstill (hold-off) period expires and the release is still awaiting a decision. If not specified the default is ‘wait’, which is the behavior of every build file written before this element existed: nothing happens and a person must validate the release. ‘release’ validates it automatically and lets it move on, so a release ships unless somebody stops it first. ‘notify’ and ‘block’ are declared but not yet implemented - a stream specifying either behaves as ‘wait’.
releaseWindow hbuildReleaseWindowType Optional Restricts WHEN a release on this stream may go, independently of how long it must wait. Absent means no restriction - 24x7. Only has an effect where onStandstillElapsed schedules something to happen.
publishDependsOn Array<hbuildStreamDependancyType> Optional The dependency on one ore more previously published streams
fileOperation Array<hbuildFileOperationType> Optional A list of file operations to perform
scpCopyFile Array<hbuildScpCopyFileType> Optional One or more optional SCP copy operations to peform
cdnTarget xs:anyURI Optional The name of a CDN target this release stream should sync to.
sshRemoteExec Array<hbuildSshRemoteExecType> Optional An SSH command to execute on the remote CDN system.
sshRemoteExec2 Array<hbuildSshRemoteExec2Type> Optional Execute command(s) on a remote target
httpInvoke xs:string Optional An HTTP(S) URL that will be called using the GET method after the release has completed
packageManager Array<hbuildPackageManagerType> Optional A package manager publish operation. You can specify one or more package manager servers to deploy to
validation hbuildValidationTestType Optional Information about an expected post build validation test
pushForward hbuildStreamPushType Optional Define this if you want to push forward to the next stream based on status change.
deploy hbuildStreamDeployType Optional The stream’s declared deployment from the build file: the deployment-target name and the content artifact. Expert-mode run steps are summarized as a count (their full detail lives in the build file).
delivery hbuildStreamDeliveryType Optional RESPONSE-ONLY, controller-derived: where this stream’s artifact is delivered. Not part of the build file - the controller resolves it from the publish scheme, package manager blocks, CDN target and deployment target registry. Only display-safe fields are exposed.
In This Document