Summer '19 - Upgrade Instructions
Important Considerations Before Upgrading to Summer '19
- This is a major release. Please refer to the relevant section depending on the version from which you are upgrading and read these instructions carefully before upgrading.
- If you want to use the pipeline manager, you need to own org credentials in each of the environments or have access to the default org credentials that have been used to authenticate the environments. This is a required step in order to commit and deploy to and from these environments.
- If you are using the Copado_User permission set, it is not required to follow the OLS, FLS, and tab visibility upgrade instructions.
Upgrade Instructions from v11 to Summer ’19
OLS, FLS for New Object Fields and Tab Visibility
Make sure the relevant custom profiles and permission sets have access to the following fields:
Copado Core
Type | Name / Label | API Name |
CustomObject | Environment | copado__Environment__c |
CustomField | Promotion Default Credential | copado__Promotion_Default_Credential__c |
CustomField | Validation Promotion Default Credential | copado__Validation_Promotion_Default_Credential__c |
Static Code Analysis
Type | Name / Label | API Name |
CustomObject | Static Code Analysis Result | copado__Static_Code_Analysis_Result__c |
CustomField | Highest Priority Violation | copado__Highest_Priority_Violation__c |
CustomField | Open | copado__Open__c |
CustomField | Won’t fix | copado__Wont_fix__c |
CustomField | Unresolved | copado__Unresolved__c |
CustomField | Resolved | copado__Resolved__c |
CustomField | Reopened | copado__Reopened__c |
CustomField | Removed | copado__Removed__c |
CustomField | Fixed | copado__Fixed__c |
CustomField | False Positive | copado__False_Positive__c |
CustomField | Confirmed | copado__Confirmed__c |
CustomField | Closed | copado__Closed__c |
Type | Name / Label | API Name |
CustomObject | Static Code Analysis Violation | copado__Static_Code_Analysis_Violation__c |
CustomField | Status | copado__Status__c |
CustomField | Resolution | copado__Resolution__c |
Custom Field | Info URL | copado__Info_URL__c |
Change Management
Type | Name / Label | API Name |
CustomObject | Promotion | copado__Promotion__c |
CustomField | Order User Stories by | copado__Order_by__c |
Type | Name / Label | API Name |
CustomObject | Pipeline | copado__Deployment_Flow__c |
CustomField | Order User Stories by | copado__Order_by__c |
Type | Name / Label | API Name |
CustomObject | User Story | copado__User_Story__c |
CustomField | Last Promotion Date | copado__Last_Promotion_Date__c |
CustomField | Environment Type | copado__Environment_Type__c |
Type | Name / Label | API Name |
CustomObject | User Story Metadata | copado__User_Story_Metadata__c |
CustomField | Last Commit Date | copado__Last_Commit_Date__c |
Type | Name / Label | API Name |
CustomObject | User Story Dependency | copado__Team_Dependency__c |
CustomField | Child User Story | copado__Child_User_Story_Status__c |
CustomField | Parent User Story | copado__Parent_User_Story_Status__c |
Agile
Type | Name / Label | API Name |
CustomObject | Epic | copado__Epic__c |
CustomField | Release | copado__Release__c |
CustomField | Cancelled Reason | copado__Cancelled_Reason__c |
Git Integration
Type | Name / Label | API Name |
CustomObject | Git Commit | copado__Git_Commit__c |
CustomField | Commit Datetime | copado__Commit_Datetime__c |
Page Layout Assignments
Assign the User Story Dependency layout of the User Story Dependency object to your profile.
Steps:
- Go to your profile.
- Click on Object Settings.
- Assign the User Story Dependency layout of the User Story Dependency object to your profile.
Record Types
Make sure relevant Profiles and Permission Sets have access to the following record types:
copado__Static_Code_Analysis_Settings__c
- CodeScan
- PMD
copado__Static_Code_Analysis_Violation__c
- CodeScan
- PMD
copado__Static_Code_Analysis_Result__c
- CodeScan
- PMD
Tabs
- Pipeline_Manager (added to perm set available - visible).
Field Sets, Visualforce Pages and Apex Classes
Navigate to Setup > Installed Packages > Copado Deployer > View Components and make sure you have the below field sets, Visualforce pages and Apex classes.
Field Sets
- ManageBranchesDialog
- Mass_Back_Promote
- Pipeline_Manager
- Pipeline_Manager_Pending_Approvals
- Snapshot_Waiting_Page
- User_Story_Waiting_Page
- Git_Commit_Header
- Remove the Git Provider field from the Custom Fields' field set in the Git Repository object (Git Repository > Field Sets > Custom Fields).
Visualforce Pages
- SnapshotWaitingFor
- GitCommitMain
- PipelineManagerDialog
- PipelinePromotion
- SetupWizardStart
- SetupWizardFinish
- PipelineTemplatesWizard
- PipelineSettingsWizard
- PipelineManager
- PipelineDiagram
- OrgAuthenticationWizard
- OrgAuthenticationInstallWizard
- NewPipeline
- CopadoLicensesWizard
Apex Classes
- UserStoryCommitService
- Test_GitCommitMainNegative
- Test_GitCommitMain
- SnapshotCommitService
- RunUserStoryTests
- GitCommit_IntermediaryController
- GitCommit_MainController
- GitCommit_MainPageController
- GitCommit_OperationsController
- GitCommit_PageBase
- GitRepositoryTriggerHelper
- CommitService
- DxCommitService
- GitCommit_AdvancedController
- GitCommit_ComponentBase
- GitCommit_GridController
- GitCommit_HeaderController
- PipelineFiltersController
- WizardHelper
- SetupWizardStartController
- SetupWizardFinishController
- ProductionOrgServiceController
- NewEnvironmentServiceController
- NewPipelineExtension
- OrgAuthenticationComponentController
- OrgAuthenticationInterface
- OrgAuthenticationWrapper
- PipelineComponentHelper
- PipelineDiagramExtension
- PipelineHeaderController
- PipelineManagerExtension
- PipelinePagesHelper
- PipelineSettingsComponentController
- PipelineTemplateComponentController
- ErrorHandlingComponentController
- DefineProductionOrgServiceController
- CopadoLicensesComponentController
- AuthenticateAnyOrgServiceController
- ScratchOrgSettings
- UIDesignHelper
Layouts
Add the fields, buttons and related lists to the required layouts:
Epic
- Add new fields: copado__Cancelled_Reason__c and copado__Release__c.
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.
- Add 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.
- Add a new section on the top of the User Story layout with the following details:
- Add new buttons:
- Validate Changes
- ManageApex Tests
- OpenPull Request
- Select Base Branch
- Add new field: copado__Last_Promotion_Date__c.
- Remove section: Apex Test Result (Apex test results are now accessed by clicking on the Manage Apex Tests button).
User Story Metadata
- Add new field: copado__Last_Commit_Date__c.
Promotion
- Add new field: copado__Order_by__c.
Deployment Flow
- Add new button: Select Main Branch.
- Add new field: copado__Order_by__c.
- Add new picklist field: copado__Calculate_Based_on__c.
- Add new field: copado__Hide_Tabs__c.
Deployment Flow Step
- Add new button: Select Branch.
Environment
- Add new fields: copado__Promotion_Default_Credential__c and copado__Validation_Promotion_Default_Credential__c.
Git Commit
- Add new field: copado__Commit_Datetime__c.
External CI Setting
Add new TeamCity picklist value to copado__CI_Tool__c.
Release
- Add new button: Select Base Branch.
Git Snapshot
- Add new button: Select Branch.
Static Code Analysis Result
- Add new field: copado__Highest_Priority_Violation__c.
Static Code Analysis Result (CodeScan)
- Create a Type section and move or add the following fields:
- copado__Bugs__c
- copado__Vulnerabilities__c
- copado__Code_Smells__c
- Create a Severity section and move or add the following fields:
- copado__Blocker__c
- copado__Critical__c
- copado__Major__c
- copado__Minor__c
- copado__Info__c
- Create a Resolution section and add the following fields:
- copado__Unresolved__c
- copado__False_Positive__c
- copado__Removed__c
- copado__Fixed__c
- copado__Wont_fix__c
- Create a Status section and add the following fields:
- copado__Open__c
- copado__Reopened__c
- copado__Confirmed__c
- copado__Resolved__c
- copado__Closed__c
Static Code Analysis Violation
- Add the following fields:
- copado__Status__c
- copado__Resolution__c
- copado__Info_URL__c
Compliance Rule
- Remove the Manage Criteria button.
- Add the Visualforce page AddCCHRuleCriteria to the Criteria section.
- Make the following changes in the VisualForce panel:
- Check the Show scrollbars checkbox.
- Set the height to 600 pixels.
- Set the width to 100%.
Upgrade Instructions from v12 to Summer ‘19
OLS, FLS for New Object Fields and Tab Visibility
Make sure the relevant custom profiles and permission sets have access to the following fields:
Copado Core
Type | Name / Label | API Name |
CustomObject | Environment | copado__Environment__c |
CustomField | Promotion Default Credential | copado__Promotion_Default_Credential__c |
CustomField | Validation Promotion Default Credential | copado__Validation_Promotion_Default_Credential__c |
Static Code Analysis
Type | Name / Label | API Name |
CustomObject | Static Code Analysis Result | copado__Static_Code_Analysis_Result__c |
CustomField | Open | copado__Open__c |
CustomField | Won’t fix | copado__Wont_fix__c |
CustomField | Unresolved | copado__Unresolved__c |
CustomField | Resolved | copado__Resolved__c |
CustomField | Reopened | copado__Reopened__c |
CustomField | Removed | copado__Removed__c |
CustomField | Fixed | copado__Fixed__c |
CustomField | False Positive | copado__False_Positive__c |
CustomField | Confirmed | copado__Confirmed__c |
CustomField | Closed | copado__Closed__c |
Type | Name / Label | API Name |
CustomObject | Static Code Analysis Violation | copado__Static_Code_Analysis_Violation__c |
CustomField | Status | copado__Status__c |
CustomField | Resolution | copado__Resolution__c |
Change Management
Type | Name / Label | API Name |
CustomObject | User Story | copado__User_Story__c |
CustomField | Last Promotion Date | copado__Last_Promotion_Date__c |
CustomField | Environment Type | copado__Environment_Type__c |
Type | Name / Label | API Name |
CustomObject | User Story Metadata | copado__User_Story_Metadata__c |
CustomField | Last Commit Date | copado__Last_Commit_Date__c |
Type | Name / Label | API Name |
CustomObject | User Story Dependency | copado__User_Story_Dependency__c |
CustomField | Child User Story | copado__Child_User_Story_Status__c |
CustomField | Parent User Story | copado__Parent_User_Story_Status__c |
Agile
Type | Name / Label | API Name |
CustomObject | Epic | copado__Epic__c |
CustomField | Release | copado__Release__c |
CustomField | Cancelled Reason | copado__Cancelled_Reason__c |
Git Integration
Type | Name / Label | API Name |
CustomObject | Git Commit | copado__Git_Commit__c |
CustomField | Commit Datetime | copado__Commit_Datetime__c |
Record Types
Make sure relevant Profiles and Permission Sets have access to the following record types:
copado__Static_Code_Analysis_Settings__c
- CodeScan
- PMD
copado__Static_Code_Analysis_Violation__c
- CodeScan
- PMD
copado__Static_Code_Analysis_Result__c
- CodeScan
- PMD
Tabs
- Pipeline_Manager (added to perm set available - visible).
FieldSets, Visualforce Pages and Apex Classes
Navigate to Setup > Installed Packages > Copado Deployer > View Components and make sure you have the below field sets, Visualforce pages and Apex classes.
Field Sets
- ManageBranchesDialog
- Mass_Back_Promote
- Pipeline_Manager
- Pipeline_Manager_Pending_Approvals
- Snapshot_Waiting_Page
- User_Story_Waiting_Page
- Git_Commit_Header
- Remove the Git Provider field from the Custom Fields' field set in the Git Repository object (Git Repository > Field Sets > Custom Fields).
Visualforce Pages
- SnapshotWaitingFor
- GitCommitMain
- PipelineManagerDialog
- PipelinePromotion
- SetupWizardStart
- SetupWizardFinish
- PipelineTemplatesWizard
- PipelineSettingsWizard
- PipelineManager
- PipelineDiagram
- OrgAuthenticationWizard
- OrgAuthenticationInstallWizard
- NewPipeline
- CopadoLicensesWizard
Apex Classes
- UserStoryCommitService
- Test_GitCommitMainNegative
- Test_GitCommitMain
- SnapshotCommitService
- RunUserStoryTests
- GitCommit_IntermediaryController
- GitCommit_MainController
- GitCommit_MainPageController
- GitCommit_OperationsController
- GitCommit_PageBase
- GitRepositoryTriggerHelper
- CommitService
- DxCommitService
- GitCommit_AdvancedController
- GitCommit_ComponentBase
- GitCommit_GridController
- GitCommit_HeaderController
- PipelineFiltersController
- WizardHelper
- SetupWizardStartController
- SetupWizardFinishController
- ProductionOrgServiceController
- NewEnvironmentServiceController
- NewPipelineExtension
- OrgAuthenticationComponentController
- OrgAuthenticationInterface
- OrgAuthenticationWrapper
- PipelineComponentHelper
- PipelineDiagramExtension
- PipelineHeaderController
- PipelineManagerExtension
- PipelinePagesHelper
- PipelineSettingsComponentController
- PipelineTemplateComponentController
- ErrorHandlingComponentController
- DefineProductionOrgServiceController
- CopadoLicensesComponentController
- AuthenticateAnyOrgServiceController
- ScratchOrgSettings
- UIDesignHelper
Layouts
Add the fields, buttons and related lists to the required layouts:
Epic
- Add new fields: copado__Cancelled_Reason__c and copado__Release__c.
User Story
- Add new field: copado__Last_Promotion_Date__c.
User Story Metadata
- Add new field: copado__Last_Commit_Date__c.
Environment
- Add new fields: copado__Promotion_Default_Credential__c and copado__Validation_Promotion_Default_Credential__c.
Git Commit
- Add new field: copado__Commit_Datetime__c.
Static Code Analysis Result (CodeScan)
- Create a Type section and move or add the following fields:
- copado__Bugs__c
- copado__Vulnerabilities__c
- copado__Code_Smells__c
- Create a Severity section and move or add the following fields:
- copado__Blocker__c
- copado__Critical__c
- copado__Major__c
- copado__Minor__c
- copado__Info__c
- Create a Resolution section and add the following fields:
- copado__Unresolved__c
- copado__False_Positive__c
- copado__Removed__c
- copado__Fixed__c
- copado__Wont_fix__c
- Create a Status section and add the following fields:
- copado__Open__c
- copado__Reopened__c
- copado__Confirmed__c
- copado__Resolved__c
- copado__Closed__c
Static Code Analysis Violation
- Add the following fields:
- copado__Status__c
- copado__Resolution__c
- copado__Info_URL__c
Compliance Rule
- Remove the Manage Criteria button.
- Add the Visualforce page AddCCHRuleCriteria to the Criteria section.
- Make the following changes in the VisualForce panel:
- Check the Show scrollbars checkbox.
- Set the height to 600 pixels.
- Set the width to 100%.