A snapshot Snapshot is a collection of build versions (project or package versions) for the release's projects of release content which are sent through the pipeline for execution. As a release progresses, newer versions of projects are assembled to create new snapshots. A release may consist of dozens, hundreds or even hundreds or thousands , of snapshots over its lifetime, depending on the release's size and duration. There are several ways in which snapshots can be created.
By a release manager by explicitly identifying the versions of the projects/packages in the release. See Creating a Snapshot.
By associating a project/package build to the release. As such, once the build completes, the new project version is overlaid on top of the most recent release snapshot to produce a new snapshot.
By promoting an existing build to a release. In this case, a new snapshot is created with the selected project version overlaid.
By using Promote to Release step in another release.
Using a Project Triggers trigger (Webhook, Poll SCM, or Scheduled Build Trigger) to automatically associate the new build with the release.
Using the REST API to submit a build request, and associate it to the release.
| Tip |
|---|
All snapshots which reach Completedstatus are sent to the pipeline for execution, and marked Initiated. Only one snapshot per release can be created (Pending) at a time. However, many snapshots can be executing the pipeline for the same release in parallel. |
To view the list of snapshots for the release, click on the Execution tab.
...
Column | Description | ||
|---|---|---|---|
Status | The current status of the snapshot:
|
|
 | |
Snapshot Name | The generated snapshot name based on the |
Description | The description which was given when the snapshot was created. |
<Stages> | The remaining columns represent the execution detail of the snapshot in the pipeline. For each stage of the pipeline, an icon represents its execution status. If no icon is displayed, the execution has not yet reached that stage.
|
Running Steps - The snapshot execution |
is currently running steps in the pipeline stage.
|
Running Gates - The snapshot execution is currently running gates in the pipeline stage. |
Running Steps - The snapshot execution is currently running steps in the pipeline stage.
Successful - The snapshot execution in the pipeline stage has successfully completed.
Created On | The date & time on which the snapshot was created. |
Created By | The user who created the snapshot. The id will be a system id if the snapshot was created due to a project build associated to the release. |
To view the details of the projects in the snapshot, click on the link in the Snapshot Name column. Make sure the Content tab is selected on the top right.
...
Column | Description |
|---|---|
Project |
The name of the project within the snapshot. |
Project Version
The version of the project build within the snapshot.
Package |
The package name for the project build within the snapshot. Only applies to partial deployment projects. If All Files is being used, you will see (All Files) for package name |
Branch
The Branch from which the project version was built.
Request All Files
. | |
Status | The status of the individual project version within the snapshot. Statuses are:
|
The project is has not yet been processed for the snapshot. There may be number of different outcomes for project, i.e. may be built or just new version may be used. |
|
The project has failed to build.
|
|
The project is currently being built for the snapshot. |
|
The project has been built successfully for the snapshot. This will be seen only if build was submitted during create snapshot process. |
No Previous Version - the project was not present in previous snapshot, so it is newly added to snapshot.
No Change - project version is same as previous snapshot.
Newer Version - project version is newer than previous snapshot. Project was built manually, triggers, rest call or using incoming webhook.
| ||
Version | The version of the project build within the snapshot. | |
Branch | The Branch from which the project version was built. | |
Request Error |
The error message of the failed build, if the status is | |||
Built On | The date and time when build was executed. | ||
Built By | The user who initiated build.
|
To view the commit details of the a snapshot version select the Show Commit Details checkbox.
...
Column
...
Description
...
Project Name
...
The name of the project within the snapshot.
...
Project Version
...
The version of the project build within the snapshot.
...
Package Name
...
The package name for the project build within the snapshot. Only applies to partial deployment projects. If All Files is being used, you will see (All Files) for package name.
...
Branch
...
drop down arrow on the left side of the row. To view commit details for all snapshot versions, select the Show Revisions checkbox above the table.
...
Column | Description |
|---|---|
File Type | The object type of the file if applicable. |
File Name (with Path) | The path and name for the specific file. |
Sequence | The sequence number of the file within the package if applicable. |
Revision | The latest SCM revision for the file or project. |
Committed By | The committer username for the SCM revision. |
Message | The commit message for the SCM revision |
Built On
The date and time when build was executed.
Built By
The user who initiated build.
The user will be a system user if build was initiated by automated process. For example,
webhook - If build was triggered by incoming webhooks. |