Creating a Snapshot

To create a new snapshot, click on the button in the top right corner of the Release page.

Snapshots can be created a variety of different ways, either automatically or manually. For example,

  • Developers can perform builds of a project and select a Release.

    • This option may be best if you want to implement CD, and not looking to implement CI yet.

  • Incoming webhooks or triggers setup on the project screen can create builds and snapshots.

    • This option may be best if you are looking at more automation and speed.

  • User can perform the promote to release action on a specific version.

    • This option may be best if you are validating a build manually first, and then decide that if the version is correct for promotion to other environments.

  • Developers can create snapshots on the release screen. This page is focused on this approach.

    • This option may be best if you are

      • Initiating build on many projects by selecting New for Project Version

      • Recreating a snapshot from a previous snapshot or selecting different versions of multiple projects.

  • If you are looking for fully automate create snapshot process, then setup Snapshot Schedule. In addition you can also use Webhook integration to initiate builds of various projects.

All these options can be initiated from the UI or through REST APIs.

Field

Description

Field

Description

Snapshot Description

An optional description for the release.

Autofill From Snapshot

Autofill new snapshot with the values from a previous snapshot as a starting point.

Skip Stages

Specify which stages can be skipped during pipeline execution. Will be disabled if there is only one stage on the pipeline, and may not be visible depending on the current user’s permissions.

<Snapshot Inputs>

Additional inputs that are defined on the pipeline’s properties.

Release Content

For each of the project/package in the release, request new builds, or specify the version information of existing builds.

Column

Description

Column

Description

Priority

The priority of the project/package as defined on release.

Project

The name of the project. Includes the folder path of the project.

Package

The name of the package in the release (read-only).  Applies to package-based deployment projects only.

Branch

The Branch from which the project version will be built.

Project Version

The build version for the project/package to include in the snapshot. Or select New to create a new build or pull in latest version.

When using New

  • If Project is configured with SCM & it supports polling then change detection is performed, new build is initiated if changes are found. If no changes are found, then latest project version for project/package/stream is included in snapshot.

  • If Project is configured with None as SCM, then new build is initiated.

Build Environment

If selecting New for project version for the project/package, select the build environment.

Force Build?

If selecting New for project version for the project/package, select whether to force build it in case of no SCM changes. If unchecked and there are no SCM changes, the last-built version will be used.

Enter the project/package details for the snapshot as described above, and click the  button in the lower-right to submit the request. Once the snapshot is created, it will be sent to the pipeline for execution, and can be viewed on the Release Dashboard.  

Keep in mind that if executing new builds as part of the snapshot, this could take several minutes.  To view the status of the snapshot click on the Execution tab on the release. Pending snapshots will always be displayed first.

Snapshots can only be created for Started releases with an assigned pipeline, and releases must contain at least one project that can be built. If you had just created your release, be sure to assign a pipeline and add projects that are buildable. If your release is paused, be sure to start it.

 

The following macros are not currently supported in the footer:
  • style