ClickDeploy
Description
ClickDeploy is an application that will support Salesforce metadata
deployments in Salesforce Platform & Solutions space.
Clickdeploy accesses Salesforce instance and displays all customizations
made, allowing to group, review and migrate it easily, without a need to
have any tools or technology.
Clickdeploy also allows to collaborate on set of changes, so development
team can create and utilize metadata containers to describe changes that
was done during development of project, and next those changes can be
migrated wherever needed.
Clickdeploy also connects to P&G github via P&G federation ID to allow
direct integration with git, so code and configuration can be moved to git
with only few clicks.
ClickDeploy stores no data, it only provides a life view of metadata
(configuration) available on Salesforce instance.
Clickdeploy has no access to any business related data.
The tool will help to connect non-technical project members to P&G CI/CD
pipelines, that will be still used for any deployment activities, allowing to
make deployments faster and easier, with less resources involved, but still
rely on all compliance requirements managed by CI/CD Pipelines.
Mega ID 46F4488860641E18
Access Request
In order to request access to E2E use of ClickDeploy, each change
implementer should request next set of accesses:
User creation in Production Organization that
will be the target org for the deployments.
We have currently 2 Production orgs:
Environments is the old org
Global New Org - Environments is the new org.
You will need to ask access to both environments, org should be
production. You can ask access via FR to this link, specifying that you need
Identity license user in order to access ClickDeploy.
Github Access to correspective organization
Access to Github can be requested via thisGitHub Repositories | High Level
Overview of repository management (for everyone)
Once request has been done, and PG Github Access confirmed, you need
to request access to GitHub groups working in Veeva Pipeline.
Please refer to GitHub Repositories | Application Access Points to know
name of groups and ask
[email protected] for access Veeva Groups.
BE AWARE: IF YOU DO NOT HAVE A P&G GITHUB ACCOUNT ALREADY,
please follow e2e documentation described in the "GitHub QuickStart
Guide" . If you need WBS (and you will do) during the process, please
ask your sponsor to provide it.
Also BE AWARE in the moment the ticket for access to P&G github is
created, You will receive an email with a confirmation link that you need to
click before 7 days. It gives you access to P&G group. Email is like this:
If you do not have a Github Account in general, please go on Github.com
website and follow these instructions:
Click on SIgn Up
and fill in the informations requested:
following the instructions in the page.
ClickDeploy first access
Once GitHub and Production Accesses are granted, you can start login to
clickDeploy. In order to access, please login with your production
Environment credentials to this link https://essentials.copado.com/.
Click the “Use Custom Domain”, type in “pgphc.my.salesforce.com” and
click Continue.
Once you are logged in, you should be able to see a screen like this:
First of all you should no link your ClickDeploy environment to Github and
the orgs from which you want to retrieve your metadata.
Please go on tab “Organizations”
and then click on Add Organization:
you will be redirected to this page:
where you need to put info about the salesforce organization you want to
retrieve the data from, and the info on the github repo you will need to
push metadata to.
Lets see how to configure both:
Salesforce Org → Organization you retrieve metadadata
from:
1. You need to select Type = Salesforce Org
2. You need to select Name of you Salesforce Org
3. You need to select Environment = Sandbox
4. You can click Authorize button
After that you need to fill in with info of your user and org URL:
and then you will be redirected to the ClickDeploy page with your
credentials filled in:
and then Test connection and Save it.
After this you will have your organization always available in your tab
“Organizations”. Lets now see how to link you GitHub repo to ClickDeploy.
GitHub → Organization you want to push metadata to:
In case of issues with Github connection, please refer to Setup Git
Connections
first of all, you need to create new organization, this time for github
Enterprise.
Please go on tab “Organizations”
and then click on Add Organization:
you will be redirected to this page:
this time you will need to select GitHub Enterprise as Type and ssh as Auth
Type:
It’s crucial to set “Source Folder” as “src” to ensure data is stored
appropriately.
then you can click on “Generate key Pair”:
the Private Key and Public Key will be automatically filled in.
Now you need to go to your GitHub page, in settings on top of your github
page:
and then go to SSH and GPG keys, clicking new SSH key:
you will be redirected to next page. Don’t put anything in the “Title”. Copy
Public Key from “GitHub” Organization record in ClickDeploy and paste
here in “Key” section. Click “Add SSH key”:
After having clicked on button “Add SSH key” you now should continue
configure ClickDeploy with missing info, like Github repository. If you have
doubts on which GitHub repo or GitHub branch to use, please ask your
tech lead in the team.
Set this link as Git Repo Url: Setup Git Connections
after this, it is finally time to start deploying
few very important rules to follow are related to branch strategy we have
decided to follow in Veeva teams.
please refer to New branching model for complete branch model.
How to deploy:
First of all you need to go in this clickdeploy window, clicking “New
Deployment”
It is very important that you take track of all your changes in ordered way.
You should use this naming convention when creating your deployment
branch: please refer to New branching model for complete branch
model..
As Source org you should select the Dev environment from where you
want to retrieve the changes.
As Target org you should select new Github environment previously
configurated.
