To start using Clayton, you’ll need to set up a connection with your version control systems or Salesforce orgs. On the connections screen in Clayton, you can add or edit repositories from various Git providers or connect to any Salesforce org (including sandboxes).
Adding a new connection
On the top left-hand side of any page, you can access the workspace settings by clicking on your name and selecting "Connections" from the dropdown menu.
On the Connections screen, you can view and edit existing connections, as well as add new ones. Only administrator users can manage connections, and any connections currently in use by one or more projects cannot be deleted.
By selecting the Add Connection button, you’ll be redirected to your chosen Git provider’s portal to log in.
BitBucket
BitBucket
When connecting, you will be prompted to install the Clayton app and grant it access to your account. This access allows Clayton to scan your repositories, generate a health report, and apply automatic changes as needed.
You can now add new repositories from the home page by clicking "Connect Repositories" or by selecting "Add New Repository" from the left-hand menu.
You can now add new repositories from the home page by clicking "Connect Repositories" or selecting "Add New Repository" from the left-hand menu.
Github
Github
When connecting to GitHub, you will be prompted to install the Clayton app and authorize the connection. During this process, you can choose to either connect all repositories or select specific ones. Once the Clayton app is installed on your GitHub profile, you will gain access to the selected repositories.
You can now add new repositories from the home page by clicking "Connect Repositories" or by selecting "Add New Repository" from the left-hand menu.
Under "Select Git Connection," your new connection will appear in the dropdown menu. On the next page, you will be able to select any repository you have the appropriate access to.
Azure DevOps
Azure DevOps
Before connecting to Azure DevOps, it is crucial to enable the Third-Party Application Access via OAuth setting in your organization's settings.
To locate this setting, follow these steps:
Navigate to Organization Settings.
Go to Security > Policies.
Ensure that the Third-Party Application Access via OAuth toggle is switched on.
Next, click on "Add Connection" and choose "Azure." You will be prompted to grant Clayton access to your Microsoft account, including read and write permissions.
You can now add new repositories from the home page by clicking "Connect Repositories" or by selecting "Add New Repository" from the left-hand menu.
Under "Select Git Connection," your new connection will appear in the dropdown menu. On the next page, you will be able to select any repository you have the appropriate access to.
GitLab
GitLab
When connecting to GitLab, you must grant permissions that provide full read/write access to the API, including all groups and projects, as well as access to the container registry, dependency proxy, and package registry. Note that we will only access or scan the repository you connect as part of the next step.
You can now add new repositories from the home page by clicking "Connect Repositories" or by selecting "Add New Repository" from the left-hand menu.
Under "Select Git Connection," your new connection will appear in the dropdown menu. On the next page, you will be able to select any repository you have the appropriate access to.
Editing connection names
To edit a connection’s name, click the pencil icon under the Actions column, where you can modify any connections you’ve set up.
Deleting connections
You can only delete a connection if it’s not in use, meaning it isn’t currently used in any projects. Check the In Use column—if the icon is red, indicating it’s not in use, you can delete the connection by clicking the bin icon in the Actions column.
Connecting Salesforce Orgs
Connecting Salesforce Orgs allows Clayton to scan and report on live Salesforce environments allowing you to audit your code and security.
To connect a Salesforce org, click the "New Project" button on the home page and select "Salesforce Org." After naming your project, you will be prompted to choose the policies you want to apply to your Salesforce org.
Your project workspace has been successfully created! The final step is to connect to Salesforce by clicking the "Connect Now" button. If you don’t have the required admin privileges, you can share the provided link with a Salesforce admin to securely connect their organization.
Got questions? Don't hesitate to contact support.