Setting Up and Using Version Control

Prerequisites

Before connecting Prodly to your version control system, please ensure you have completed the following steps:

• Identify Your Control environment The Prodly managed package must be installed in the Salesforce environment that contains your source-of-truth data. This environment, known as your control environment, is where you will perform the setup.

• Create an Empty Git Repository

  Release uses a single repository in your version control system to track and manage changes you make to the data in all the environments you place under version control. Prodly recommends starting with an empty repository containing only the default main branch.

• Generate a Personal Access Token (PAT) In most cases, a PAT is used to securely authenticate your account. You must generate a PAT from your user settings in your VCS. Ensure it has the necessary scopes (permissions) to both read from and write to your repositories. Copy this token to a safe place; you will need it during setup. See VCS Access Scopes for detailed requirements.

Azure OAuth Connection Setup

Connecting Your Repository (Initial Setup)

In the current release, Prodly integrates with Azure, Bitbucket, GitHub, and Gitlab, giving you the power of their collaboration tools.

Our current release integrates with Azure Cloud, Bitbucket Cloud, Bitbucket Server, GitHub Cloud, GitLab Cloud and several flavors of GitHub Enterprise Server. Refer to the Azure, Bitbucket, GitHub, or GitLab documentation to correctly configure the VCS environment (access permissions, etc.) for your use case. For assistance creating a repository, refer to the related Azure, Bitbucket, GitHub,or GitLab help topic.

1. In the Release tab, navigate to the Settings page and see Version Control.
2. Click Set Up to launch the version control setup wizard.
3. On the Connect page of the wizard:

   1. In the Version Control System list, select the version control system to use.

      <aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

      If Azure Cloud is not in the list:

      1. In the Salesforce environment where you installed the Prodly managed package, navigate to Setup → Object Manager → VCS Repo → Fields & Relationships → Repo Type.
      2. Scroll down to the Values section and click New.
      3. Enter Azure Repo.
      4. Click Save. </aside>

   2. Specify the parameters Prodly needs to access your VCS account:

      • For Bitbucket Cloud:
        1. In the Workspace box, enter your Bitbucket account workspace.
        2. Notice Release automatically sets Base URL to bitbucket.org.
      • For Bitbucket Server:
        1. In the Personal Access Token box, enter the Bitbucket personal access token for your VCS account.
        2. In the Project URL box, enter the web address of your VCS account.
      • For GitHub Cloud:
        1. Select an Authentication Method.
        2. When Authentication Method is Personal Access Token, in the Personal Access Token box, enter the GitHub personal access token for your VCS account.
        3. For either authentication method, in the Base URL box, enter the web address of your VCS account.
      • For GitHub Enterprise Server:
        1. In the Personal Access Token box, enter the GitHub personal access token for your VCS account.
        2. In the Base URL box, enter the web address of your VCS account.
      • For Azure Cloud:
        1. In the Personal Access Token box, enter the Azure personal access token for your VCS account.
        2. If you are setting up Azure Cloud with an OAuth, refer to the Azure OAuth Connection instructions.
        3. In the Project URL box, enter the web address of the Azure project in your VCS to use.
      • For GitLab Cloud:
        1. Select an Authentication Method.
        2. When Authentication Method is Personal Access Token, in the Personal Access Token box, enter the GitLab personal access token for your VCS account.
        3. For either authentication method, in the Base URL box, enter the web address of your VCS account.

   3. Click Connect.

   4. Follow the prompts to establish a connection between Prodly and your version control system for your Salesforce user.

   5. In the Repository list, select the repository to use for version control.

   6. In the Branch list retrieved from the repository, select a branch.

   7. Select Next.

   8. If you wish to save metadata to the branch during setup, select a Metadata Filter.

   9. Set a Default Branch Folder. Metadata will be deployed to or from this folder by default for all future deployments that this branch is part of. The folder will be created if it does not exist. This can be changed at any time in Settings, where you can also add additional folders to deploy to. If you do not want to use folders, use “/”.

   10. Select Next or Skip this step.

   11. If you wish to save data to the branch during setup, select a Data Set or a Deployment Plan.

   12. Set a Default Branch Folder. Data will be deployed to or from this folder by default for all future deployments that this branch is part of. The folder will be created if it does not exist. This can be changed at any time in Settings, where you can also add additional folders to deploy to. If you do not want to use folders, use “/”.

   13. Click Next or Skip this step.

   14. If you have chosen to save metadata and/or data, add a Commit Message and ****click Save.

   15. If you have chosen not to save metadata and/or data, click Connect.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

If you are using this wizard after disconnecting from a VCS repository and you are currently logged in to your VCS, Reconnect replaces Connect, which allows you to easily reconnect to the same VCS account. To use a different VCS account, log out of your VCS and refresh the wizard page to display Connect.

</aside>

When initialization completes, your repository information appears in the Version Control card ****in Settings.

All available branches and specified branch folders will appear in Source and Destination fields when deploying, as long as you have a valid connection to your repository.

Linking Branches to Environments

Branches can be linked to environments on the Environments page, helping you clearly organize deployments and understand which branch corresponds to each environment. You can link branches to existing environments, or when adding a new environment.

For New Environments

• Visit Environments within the Release tab.