All Collections
Build
Pipeline
Pipeline's Version History
Pipeline's Version History

Learn more about the Pipeline History version and its functionalities.

Gabrielly Pereira avatar
Written by Gabrielly Pereira
Updated over a week ago

IMPORTANT: This documentation has been discontinued. Read the updated Pipeline's Version History documentation on our new documentation portal.

Initial information

In order to access the pipeline history version, you must have the permission BETA: PIPELINE-HISTORY. To learn more about Digibee’s system roles and their respective permissions, visit the System roles and default groups article.

Pipeline versioning conditions

The pipeline uses the 2-level versioning system. The first number in a version is the Major, the second is the Minor. E.g.: v.1.2, Major = 1, Minor = 2.

Major versions are used to distinguish the main versions of a pipeline, i.e., to be able to create main versions of a pipeline without modifying previously created versions. In this way, we obtain different version histories because the pipeline history refers to a single Major version and its respective Minor versions.

Moreover, Major versions also allow the same pipeline to have different concurrent deployments based on their Major versions.

Minor versions, in turn, contain changes made within the same Major version of a pipeline.

By default, whenever a pipeline is changed and saved, the Platform assumes that a new Minor version should be created and does so automatically. For example, if we deploy the latest Minor version of a pipeline and later change it, another Minor version will be created, preserving the deployed version.

Also, multiple simultaneous deployments are not possible with Minor versions, as they are always associated with the same Major version.

IMPORTANT: To create a new Major version, you must run the procedure manually from an existing Major version.

Overview

The version history lists all Minor versions of a pipeline based on their Major version. This allows you to know who last edited each version and when it was changed. You can also determine if a particular version is deployed and in which environment (test or prod).

You can also perform different actions in the version history, such as editing the latest Minor version of the pipeline, viewing and creating a new version from an existing version, and archiving a specific version, as explained in this article.

IMPORTANT: The information about who edited a version will only displayed in versions created after February 1, 2022. Versions created before that date have no user data in their history and display the default value "No data". Pipelines created before February 15, 2021 have no change date information and display 12/31/1969 by default.

How to access the Pipeline’s History version

In Build, identify the pipeline that has at least one Minor version from which you want to access the history.

After that, click on the “View history” button as shown below:

This displays the Pipeline History, which contains information about all Minor versions of the pipeline. See the example below:

Among the most important information provided by History are:

  • Deployed versions: When one of the Minor versions of the pipeline is deployed, this information appears in the History of that pipeline as well as in the respective environment (test or prod).

  • Version: Each Minor version of the pipeline;

  • Changed by: Name and email address of the user who last modified a particular pipeline version;

  • Changed at: Date and time the Minor version was modified;

  • Pipeline description: Pipeline description.

You can also select how many items (i.e. versions) per page you want to see in the history. You can also navigate through the history using the pagination in the lower right corner.

Actions

Depending on the Minor version of the pipeline, certain actions can be performed through the History itself. They are:

Edit pipeline

Through History, it is possible to edit the last Minor version of the pipeline as long as it is not archived.

To edit it, simply click on the "Edit Pipeline" button, which will redirect you to Canvas.

IMPORTANT: When you edit the latest version of the pipeline and click "Save", you create a new Minor version, which is the current version of the pipeline. Also, it is important to know that only the latest Minor version can be edited.

View pipeline

All older Minor versions of a pipeline are available for viewing as long as they are not archived.

To view a specific version directly on Canvas, simply click on “View pipeline”.

On Canvas, you can view Minor's trigger and components and their settings, view all previous versions of the pipeline, and create a new (editable) version of a pipeline from the current version. See the example:

Thus, it is possible to navigate between the old Minor versions of a pipeline and visualize them using the history built into Canvas. It is important to inform you that it is not possible to edit the trigger and the components settings of these versions, as they are pipelines available for viewing only. The only editable Minor version is the most recent and therefore the current pipeline version.

However, you can use the older Minor versions to create the current and editable version of the pipeline. To do this, create a Minor version from the desired old version by using the “Create Minor version” button in the upper right corner.

IMPORTANT: To do this, the Minor version must not be archived. If it is archived, the “Restore” button will replace the “Create Minor version” button.

It is also possible to view the current version of the pipeline using the “See latest version” button. In this case, this pipeline is fully editable, because it is the latest Minor version.

Finally, if you click on “Back to pipeline history” in the upper left corner, you will be redirected to the history.

Archive pipeline

You can archive any version of the pipeline, whether old or newer, by clicking "Archive pipeline".

IMPORTANT: Only non-archived versions can be deployed in test and prod environments in the Run menu. That is, if a version is archived, it will not be displayed when creating new deployments.

Restore pipeline

Once a pipeline version is archived, you can restore it using the "Restore pipeline" button, making it available for access.

Create new Minor version

It is possible to create a new Minor version from an old version as long as it is not archived. To do this, simply identify the version you want and click on the "Create new minor version" button. This will create a copy of the version and redirect you to Canvas where you can edit it.

IMPORTANT: When you create a copy of a particular pipeline version, you are creating the latest Minor version and thus the latest and editable version of the pipeline.

Terms of use

When using the Pipeline’s History version, you automatically make your adhesion to the Beta program and agree with the terms of use. For more information about beta versions, visit the Beta program article.

Feedback

We would like to hear your comments and suggestions on this feature. See how easy it is to send your feedback:

Did this answer your question?