Version 12 - Upgrade Instructions

Updated 1 year ago by Copado Solutions


This is a major release. Please, read these Upgrade Instructions before upgrading and follow them carefully afterwards. Test on a Sandbox First.

Upgrading to v12 will leave unauthenticated your Git repository records that are using https authentication. You will be required to manually re-authenticate them by entering your username and password again and saving. This is required due to an enhancement on Git repository credentials.


  • Salesforce released a new cool feature in Spring 18 that  allows you to change the color scheme of your dashboards. This feature requires a specific permission in order to enable it through a profile or permission set level. Copado has built-in dashboards within the package. If while installing Copado v12 or upgrading your current version of Copado to v12  you encounter the error ‘User doesn't have permission (changeDashboardColors) to create dashboard with colors’, please follow the steps below:
    • If you have a custom profile, you can easily enable the Change Dashboard Colors feature from System permissions section of your profile.
    • If you have a standard profile such as System Admin, you will not be able to edit your profile, so you need to create a permission set, enable Change Dashboard Colors and assign it to yourself. 
  • If you are using Copado_User permission set, it is not required to follow the OLS, FLS, and Tab Visibility upgrade instructions.

OLS, FLS for New Object Fields and Tab Visibility

Make sure relevant Profiles and Permission Sets have access to the following fields:


  • copado__Promotion__c.copado__Order_by__c


  • copado__Deployment_Flow__c.copado__Order_by__c


  • copado__Static_Code_Analysis_Result__c.copado__Highest_Priority_Violation__c

Record Types

Make sure relevant Profiles and Permission Sets have access to the following record types:


  • CodeScan
  • PMD


  • CodeScan
  • PMD


Add the fields, buttons and related lists to the required layouts:

User Story
  • The Deployment Flow path that originally appeared on top of the User Story is now a Visualforce page that you can add to the standard layout
  • Include new VisualForce page: UserStory
    • Add a new section on the top of the User Story layout with the following details:
      • Name: User Story Header
      • On Detail Page: unchecked
      • On Edit Page: unchecked
      • Layout: 1-Column
    • Click on the Visualforce options and drag the UserStory page to the new section.
    • Edit the Visualforce properties and set the Width to 100% and Height to 40.
  • Include new buttons:
    • Validate Changes
    • ManageApex Tests
    • OpenPull Request
    • Select Base Branch
  • Remove section: Apex Test Result (Apex test results are now accessed by clicking on the Manage Apex Tests button)
  • Include new field: copado__Order_by__c
Deployment Flow
  • Include new button: Select Main Branch
  • Include new field: copado__Order_by__c
  • Include new picklist field: copado__Calculate_Based_on__c
  • Include new field: copado__Hide_Tabs__c
Deployment Flow Step
  • Include new button: Select Branch
External CI Setting

Add new TeamCity picklist value to copado__CI_Tool__c.

  • Include new button: Select Base Branch.
Git Snapshot
  • Include new button: Select Branch.
Static Code Analysis Result
  • Include new field: copado__Highest_Priority_Violation__c

Change to Deployment Flow to User Story Based

Update the field copado__Calculate_Based_On__c to User Story

In the copado__Hide_Tabs__c field, select the following:

  • Commit Ahead
  • Commit Behind
  • File Differences
  • Auto Resolved Conflicts
  • Merged Files

Leverage the Sprint Burndown Chart

  1. Update the Story Points SFDC field of all user stories linked to a sprint if this field value is null. Run this Apex Anonymous script in the Developer Console (run it several times if you have more than 1000 user stories that meet the query's criteria):
List<copado__User_Story__c> userStories = new List<copado__User_Story__c>(); 

for(copado__User_Story__c us : [SELECT Id, copado__Story_Points_SFDC__c FROM copado__User_Story__c Where

copado__Story_Points_SFDC__c = null AND copado__Sprint__c != null LIMIT 1000]) {

us.copado__Story_Points_SFDC__c = 0;



update userStories;
  1. Follow the steps in the article How to Schedule a Burndown Chart Calculation to schedule the Burndown Chart calculation Apex class.

How did we do?