Table of Contents | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Terminology
Below are the common key terms used through the Release Dashboard UI and documentation
Term | Meaning |
---|---|
Release Content | Release Content is the logical grouping of Projects, Packages and Work Items that define a Release |
Snapshot | A Snapshot is simply a build of all the Release Content. Similar to how Projects being built generate a unique Project Version, the same can be thought of for a Release and Snapshots. This may be used somewhat interchangeably with Snapshot Content |
Snapshot Versions | Since a Release consists of multiple Projects or Packages, when building a Snapshot each Project/Package gets built and versioned individually (Snapshot Version) and aggregated into a Snapshot. You can think of a Snapshot being nothing more than a list of Snapshot Versions or Project Versions |
Pipeline Execution | Once a Snapshot is built it then moves through the Pipeline configured on the Release. This is known as a Pipeline Execution. |
Release Dashboard | Release Dashboard is nothing more than a tool for visualizing and managing Pipeline Executions. |
Stage Actions
Action | Description | Notes |
---|---|---|
Abort Stage | Aborts the Stage and any currently running Gates or Steps in the Stage | Requires Manage Stage Execution permission. The Stage can only be aborted while in a running state (Gates Running, Gates Completed, Steps Running). |
Replay Stage | Replay the Stage. Any previously executed Gates or Steps, successful or otherwise, will be replayed as well. | Requires Manage Stage Execution permission. The Stage can only be replayed while in a halted state (Aborted, Failed, Gates Failed, Rejected). |
View Execution Variables | The Pipeline used by the Release is able to define runtime Variables to customize execution logic in real time. This button will open a view to visualize the current values of any such Pipeline Variables. | Any user with Read permission on the Release can view this information. |
Upload Execution Info | Allows the viewing or modification of the Stage Execution Info. | Any user with Read permission on the Release can view the Stage Execution Info but modifying requires the Upload Execution Info permission. |
...
Status | Description | Notes |
---|---|---|
Aborted | The Step or Gate was aborted. | Note that users cannot directly abort Steps or Gates but rather abort the Stage, which indirectly results in an Aborted Step or Gate. |
Failed | The Step or Gate failed executing. | Perhaps the most broad status, Failed can occur in a number of ways:
|
Pending Approval | The Gate is awaiting an approval | Both Approval Gate and External Approval Gate will be in this status while waiting for the Approval. |
Pending Review | The Step is waiting for Review | Most commonly seen in the Predeploy and Predeploy All Steps |
Rejected | The Step has been Rejected by the User | |
Running | The Step or Gate is currently running | |
Out of Date | The Gate is Out of Date | Due to the nature of Out of Date, it is only possible for Gates to be Out of Date. For a more detailed description of Out of Date and Pipeline Execution processing see here. |
Scheduled | The Step or Gate is currently scheduled | |
Skipped | The Step or Gate has been skipped due to a precondition being false | Note that skipped is only displayed in the case of a precondition. A user manually skipping or overriding a Gate or Step will show a status of Success. |
Success | The Step or Gate has completed successfully. |
Snapshot Statuses
Status | Description | Notes |
---|---|---|
Aborted | The Snapshot was aborted. | Only available while the Snapshot is Pending (building). Note that builds may continue to run if they had already been started prior to abort being initiated. |
Completed | The Snapshot has finished building but is not yet Initiated | |
Failed | The Snapshot has failed to build. | Most commonly this occurs if one of the Projects or Packages within the Snapshot failed during build. |
Initiated | The Snapshot has now completed building and is running through the Pipeline Execution | |
Pending | The Snapshot Versions are currently building |
Snapshot Version Statuses
Status | Description | Notes |
---|---|---|
Aborted | The Snapshot Version was aborted. | Typically this is due to the Snapshot itself being aborted but it is also possible an individual build was aborted from the Project Execution screen. |
Completed | A new Snapshot Version has built successfully. | This only displays if the Snapshot Version built a new version, either through Force Build being checked or changes being detected. |
Existing | A previous Snapshot Version was found and used. | This can occur if no changes were detected during build and a valid Project Version already exists that can be used. |
Failed | The Snapshot Version has failed to build. | An error occurred while building this Snapshot Version |
Pending | The Snapshot Version is waiting to be built | Unlike Running, this Snapshot Version is still waiting to be built, typically due to resource limitations. |
Running | The Snapshot Version is currently being built. |