Integrate Version Control Systems (VCS) with Facets

This document provides a step-by-step guide for integrating version control system(VCS) accounts in your Control Plane. Github, Gitlab, and Bitbucket can currently be integrated with Facets.

How to Add a VCS Account in Facets?

Navigate to Settings > Accounts from your sidebar.
All the accounts integrated with Facets will be displayed here.

Github account

1. Select Github from the Add Account widget on the screen.
2. Fill in the Name you want to associate with this account in the Control Plane.
3. Enter the link where this is Hosted on and click Next.
4. Now, click Generate Token.
   1. This will redirect you to the GitHub Personal Access Tokens page where the Scopes are pre-selected.
      Note: When creating your Personal Access Token, Facets recommends setting the expiry to the maximum time frame for ease of use.
   2. Click Generate Token and copy the generated token.
5. Paste the Personal Access Token in the Control Plane and click Link.

You have successfully linked your GitHub account. Your account details will now be available under the Account Management page.

GitLab account

1. Select GitLab from the Add Account widget on the screen.
2. Fill in the Name you want to associate with this account in the Control Plane and click Next.
3. Now, click Generate Token.
   1. This will redirect you to Gitlab's Personal Access Tokens page.
   2. Click Add new token.
   3. Mention the Token name, and Expiration Date. The Scopes are pre-selected.
      Note: When creating your Personal Access Token, Facets recommends setting the expiry to the maximum time frame for ease of use.
   4. Click Create personal access token and copy the generated token.
4. Paste the Personal Access Token in the Control Plane and click Link.

You have successfully linked your Gitlab account. Your account details will now be available under the Account Management page.

Bitbucket account

1. Select Bitbucket from the Add Account widget on the screen.

2. Fill in the Name you want to associate with this account in the Control Plane.

3. Enter your Bitbucket Username and the App Password.
   For detailed instructions on creating an app password, refer to this guide.

   Note: When creating the app password, ensure you grant the following permissions:

   • Account: Read
   • Workspace Membership: Read
   • Projects: Write, Admin
   • Repositories: Admin

4. Select the Organization Name from the drop-down.
   Note: Ensure you have the necessary access to create repositories in the selected workspace (Organization).

5. Click Verify Account to ensure that the account details are correct.

6. Click Create.

You have successfully linked your Bitbucket account. Your account details will now be available under the Account Management page.