User Story Commit Page for Multi-Cloud

Updated 1 week ago by Copado Solutions

Overview

When committing changes from a user story, Copado displays the User Story Commit page, where you can commit the changes that have been made in the source environment according to the requirements indicated in the User Story. The commit page allows you to commit your changes and interact with Git without advanced technical expertise.

However, the User Story Commit page will vary depending on the platform you are using. 

  • If your Pipeline’s platform is Salesforce, then the classic Copado User Story Commit page will be displayed (please refer to the Metadata Grid article for further information about the classic Copado User Story Commit page). 
  • If you use a different platform, the Commit Changes button in the user story will lead you to the Multi-Cloud User Story Commit page. Furthermore, the table will be different depending on the extension installed.

Note: Please refer to the Introduction to Multi-Cloud article for further information about Multi-Cloud.

Multi-Cloud User Story Commit Page

The Multi-Cloud User Story Commit page consists of four different components: 

  1. Header
  2. Table Actions
  3. Table
  4. Git Operations

“Header” Component
This component is provided by the Copado Managed Package and will always be displayed on the Commit page, as it cannot be removed or hidden.

This component allows you to go back to the user story by using the breadcrumbs and to commit your changes with the Commit Changes button.

In previous Copado versions, you will be able to go back to the user story page with the Back to User Story option instead of with the breadcrumbs.

Additionally, the following fields will be displayed in the Header component:

  • Sprint
  • Project
  • Release
  • Developer
  • Status

These fields will be displayed by default. However, you can customize the fields that will be displayed. To do so, follow the steps below:

  1. Go to Setup > Object Manager and select the User Story object.
  2. Click on Field Sets.
  3. Select the Commit Page field set and select the fields to display.

When you select the fields to displayed in the Header component, please bear in mind the following considerations:

  • A maximum of 7 fields can be displayed in the header. If you configure more, only the first 7 fields will be displayed.
  • If the title of the user story is too long, it will be trimmed in the header.
  • If the Record Type field is added, it will not be treated as a link, but as a text string.
“Table Actions” Component

This component allows you to specify which files you want to retrieve and be displayed in the table.

This component is provided by your Multi-Cloud solution, so the options displayed in the “Table Actions” component will vary depending on the extension you are using.

“Table Actions” Component for the Copado DX Solution

The Copado DX solution provides an out-of-the-box component that allows you to pull or retrieve changes from the User Story source environment. This component consists of two options:

  1. Pull Changes by Date: This option allows you to specify any desired date and, optionally, a time, so that the table component displays a list of the files which have been modified in the source environment since the specified date.

At the same time, Copado will internally perform some operations by default:

  • The date and time will be based on the Latest Commit Date field in the user story. 
  • If this field is not populated, the date and time will be based on the Start Date field of the sprint.
  • If the user story is not linked to any sprint, the Pull Changes by Date field will remain empty and you will be able to enter any desired date and/or time.
Please bear in mind that, if no changes were made since the specified date, the table will remain empty.

When you use this option, it is also important to bear in mind that this button is only available when the source org is a Scratch Org, Developer or Developer Pro sandbox, and when Source Tracking is enabled in the production org. To enable it:

  • Go to SetupDev Hub → Select Enable Source Tracking in Developer and Developer Pro Sandboxes.
  • Refresh the sandbox after enabling this feature.
There are some metadata types which are not supported by this functionality, such as SharingRules or ManagedContentType. In this case, you need to use the Retrieve Metadata By Name and Type option. For more information about unsupported metadata types by Source Tracking API, check out the Salesforce Metadata Coverage report. 
  1. Retrieve Metadata by Type and Name: This component allows you to select a file type and perform a more specific search by entering a file name. For example, this component is useful when you need to retrieve information that cannot be obtained by the Pull Changes by Date option or when you want to commit files that you have not changed, but that have a dependency on some files which you have changed.
“Table” Component
This component is provided by the Copado Managed Package and will always be displayed on the Commit Page, as it cannot be removed or hidden.

The information provided in the Table will be based on the results provided by the Table Actions component. Each row in the Table represents a file that you can effortlessly search and select to commit, making the commit process much simpler.

The Table displays different elements which will allow you to perform different operations, which may vary depending on the extension that you are using.

“Table” Component for the Copado DX Solution

In the case of Copado DX, the following options will be displayed:

  1. Name: This column includes the name of the file.
  2. Type: This column includes the different types of the components.
  3. Directory: In Multi-Cloud, this value will be populated by the Table Actions component when the files are listed in the table. For the Copado DX solution, the directory is a hardcoded string that can be edited and modified.
  4. Last Modified Date: This field displays the date in which a component was last modified. You can sort this column in ascending or descending order.
  5. Last Modified By: This column displays the name of the users who have last modified a component and can be sorted in ascending or descending order.
  6. Operation: This option is an editable picklist which allows you to specify the type of Git operation that you want to apply on a file of the Table:
    1. Add: This file will be committed as an addition.
    2. Delete: This file will be committed as a removal.
    3. Retrieve Only: This file will be committed to provide accessory permissions to a Profile or Permission Set.
    4. Full: This operation is only available for Profiles and permission Sets, and it indicates that both attributes and accessory permissions will be retrieved and committed.
    It is possible to modify the Operation. Once you have made the corresponding changes, you can either Cancel or Save
Bear in mind that, depending on the file type, different operations may be required. Therefore, please make sure you perform the correct operation to the selected file.
  1. Show Previous Changes: If this toggle is enabled, the Table will also display the files that have been previously committed.
  2. Search Changes: This option is only applicable to text fields; dates are not supported. Furthermore, it is possible to perform partial and literal keyword searches.
“Git Operations” Component
The Git Operations component shown in this section corresponds to a coming Copado version. In the current version, this component will appear in the main User Story Commit page. However, the information provided in this section applies both to the current and coming version.
This component is provided by the Copado Managed Package and will always be displayed when clicking the Commit Changes button in the User Story Commit Page, as it cannot be removed or hidden.

In the Commit Changes screen, you will be able to perform the following operations:

  1. Commit Message: This is a mandatory field where you will need to provide a descriptive message for the commit. By default, this will be a combination of the User Story Name (US-xxxx) and the User Story Title.
  2. Re-create Feature Branch: This is an optional field which will affect the creation of the feature branch and how the changes will be committed:
    1. If this checkbox is selected, during the commit process Copado will delete the previously created feature branch in the Git repository, create a new feature branch and commit the selected files. Previous commits will not be present in the new feature branch.
    2. If the checkbox is not selected, Copado will commit the selected files in the existing feature branch.
    It is possible to prevent certain users from re-creating the feature branch. To do this, follow the steps below:
    1. Navigate to Setup > Custom Settings.
    2. Click on Manage next to Personal Settings.
    3. Click on Edit next to the name of the user or profile you want to edit the settings for.
    4. Select the Disable Re-Create Feature Branch in US checkbox and click on Save.
  3. Change Base Branch: This is an optional field which will affect the creation of the feature branch and how the changes will be committed. By default, the user story feature branch is created out of master or main. The Change Base Branch toggle in the Commit Page enables you to enter a different base branch in the Select Base Branch field. Please bear in mind that it is case sensitive and it must match the exact casing of the branch in Git. It is possible to prevent certain users from changing the base branch if a specific custom permission is not assigned. To assign this custom permission, you will need to:
    1. Navigate to Setup.
    2. Search for Custom Permissions.
    3. Click on Edit next to Edit User Story Commit Base Branch and click Add.
    4. Click on Save.

Warning Messages During the Commit Process

During the Multi-Cloud commit changes process, different warning messages will be displayed in the User Story page to indicate the status of the commit process:

  • In progress: The message will indicate that there is a commit in progress and that you cannot perform other commits until this operation has finished.
  • Failed: The message will indicate that there has been an error during the commit process.
  • Completed successfully: The message will indicate that the commit has been successfully completed.

These messages will also contain a link which will lead you to the User Story commit record, where you will find more details about the execution process step by step.

It is important to know that banners will be updated every 30 seconds to obtain the job execution status related to the User Story commit.


How did we do?