A Snapshot is a collection of build versions (project versions) of release projects which are sent through the pipeline. As a release progresses, newer versions of projects are assembled to create new snapshots. A release may consist of dozens, hundreds or even 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.
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. |
...
Column | Description | ||
---|---|---|---|
Status | The current status of the snapshot: Completed - The snapshot was successfully assembled, but has not yet been sent to pipeline for execution. Failed - The snapshot failed to be assembled (which could mean the underlying build failed). Initiated - The snapshot has been sent to the pipeline for execution. Pending - The snapshot is in the process of being assembled and set to the pipeline for execution. Aborted - The snapshot was aborted by a user.
| ||
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. Successful - The snapshot execution in the pipeline stage has successfully completed. Aborted - The snapshot execution in the pipeline stage was aborted by a user. Failed - The snapshot execution in the pipeline stage failed. Running Gates - The snapshot execution is currently running gates in the pipeline stage. Gates Failed - The snapshot failed one of the gate conditions. Gates Complete - The snapshot has completed the gates, but is not running steps yet (e.g. another snapshot is running steps in that stage). Running Steps - The snapshot execution is currently running steps in the pipeline stage. Out of Date - The snapshot execution has been superseded by a newer snapshot. Rejected - The snapshot execution has been rejected (via an approval gate) by a user. | ||
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. |
...