Skip to main content

Source Control

The Source Control settings menu in the Digisquares platform allows users to integrate their projects with various source control platforms like GitHub, GitLab, AWS CodeCommit, Azure Repos, and Bitbucket. This section provides step-by-step instructions for configuring a GitHub integration, enabling seamless version control and repository management within your Digisquares environment.

Configuring GitHub Integration​

The following instructions guide you through setting up GitHub as a source control integration for your project. This includes configuring repository details, access credentials, and linking specific branches to your development, testing, or production stages.

Step 1: Select Source Control Platform​

  • Navigate to the Source Control settings page.
  • Click on the GitHub tab to start configuring your GitHub integration.

Step 2: Set Up Repository Configuration​

  • GitHub Owner: Enter the GitHub username or organization name that owns the repository.
  • GitHub Repository: Enter the name of the GitHub repository you want to connect.
  • GitHub Branch: Specify the branch you want to link (e.g., main, dev, production).
  • GitHub Enterprise URL (optional): If you’re using GitHub Enterprise, enter the URL of your GitHub Enterprise instance.
  • GitHub Enterprise API URL (optional): If required, enter the API URL for your GitHub Enterprise instance.

Example GitHub Configuration​

Below is an example of what the GitHub configuration fields might look like when filled out:

GitHub Owner: my-github-username
GitHub Repository: my-project-repo
GitHub Branch: main
GitHub Enterprise URL: https://github.example.com
GitHub Enterprise API URL: https://github.example.com/api/v3
App ID: 123456
App Installation ID: 654321
App Private Key: -----BEGIN PRIVATE KEY-----\nMIIEvg...-----END PRIVATE KEY-----

Configuring GitLab Integration​

The following instructions guide you through setting up GitLab as a source control integration for your project. This includes configuring repository details, access credentials, and linking specific branches to your development, testing, or production stages.

Step 1: Select Source Control Platform​

  • Navigate to the Source Control settings page.
  • Click on the GitLab tab to start configuring your GitLab integration.

Step 2: Set Up Repository Configuration​

Deployment Configuration​

  • GitLab Organization: Enter the GitLab organization name that owns the repository.
  • GitLab Repository: Enter the name of the GitLab repository you want to connect.
  • GitLab Branch: Specify the branch you want to link (e.g., main, dev, production).
  • GitLab Project ID: Enter the Project ID of your GitLab project.
  • GitLab URL (optional): If you’re using a custom GitLab instance, enter the URL.

Step 3: Access Configuration​

In this section, provide the necessary credentials to allow Digisquares to interact with your GitLab repository securely.

  • Project Access Token: Enter the access token generated in GitLab to allow access to your repository.

Step 4: Configure Deployment Stage​

  • Select Stage: Choose the stage (Development, Testing, or Production) you want to associate with this GitLab integration. This enables you to manage deployments across different project stages.
  • Once you have completed these configurations, click Save to apply the settings.

Example GitLab Configuration​

Below is an example of what the GitLab configuration fields might look like when filled out:

GitLab Organization: Test GitLab
GitLab Repository: my-gitlab-repo
GitLab Branch: main
GitLab Project ID: 12345
GitLab URL: https://gitlab.example.com
Project Access Token: *****-generated-access-token

Configuring AWS CodeCommit Integration​

The following steps guide you through setting up AWS CodeCommit as a source control integration for your project. This includes configuring repository details, access credentials, and linking specific branches to different project stages.

Step 1: Select AWS CodeCommit as the Source Control Platform​

  • Navigate to the Source Control settings page.
  • Click on the AWS CodeCommit tab to begin the configuration process.

Step 2: Set Up Repository Configuration​

  1. AWS CodeCommit Repository: Enter the name of the repository you want to connect.
  2. AWS CodeCommit Branch: Specify the branch you want to link (e.g., main, dev, production).
  3. AWS CodeCommit Region: Select the AWS region where your CodeCommit repository is hosted from the dropdown menu.

Step 3: Access Configuration​

In this section, provide the necessary credentials to allow Digisquares to interact with your AWS CodeCommit repository securely.

  1. Access Key ID: Enter your AWS access key ID.
  2. Secret Access Key: Enter the secret access key associated with the access key ID.
  3. HTTPS Username: Input the username used for HTTPS Git credentials.
  4. HTTPS Password: Input the password associated with the HTTPS Git credentials.

Step 4: Select Deployment Stage​

  • Select Stage: Choose the stage (Development, Testing, or Production) you want to associate with this AWS CodeCommit integration. This step ensures you can manage deployments across different project stages.

Example AWS CodeCommit Configuration​

Below is an example of what the AWS CodeCommit configuration fields might look like when filled out:

AWS CodeCommit Repository: my-repo
AWS CodeCommit Branch: main
AWS CodeCommit Region: us-west-2
Access Key ID: AKIAIOSFODNN7EXAMPLE
Secret Access Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
HTTPS Username: my-username
HTTPS Password: my-password

Configuring Azure Repos​

The Azure Repos integration in the Digisquares platform allows users to connect their project to Azure DevOps for source control. Follow the steps below to configure Azure Repos, enabling seamless repository management within your Digisquares environment.

The following instructions guide you through setting up Azure Repos as a source control integration. This includes specifying repository details, configuring access credentials, and linking specific branches to your project stages.

Step-by-Step Configuration​

  1. Select Source Control Platform

    • Navigate to the Source Control settings page.
    • Click on the Azure Repos tab to begin configuring your Azure integration.

  2. Repository Configuration

    • Azure Repository: Enter the name of the repository you want to link.
    • Azure Organization: Enter your Azure DevOps organization name.
    • Azure Branch: Specify the branch you want to associate with the selected stage (e.g., main, dev).
    • Project: Enter the name of your Azure DevOps project.
    • User: Specify the username for the Azure account.

  3. Access Configuration

    • Personal Access Token: Enter a personal access token to authenticate the connection. Ensure this token has appropriate permissions for repository access.
    • Use Basic Auth: Toggle this option if you are using basic authentication to access Azure Repos.

  4. Select Stage

    • Select Stage: Choose the stage (Development, Testing, or Production) you want to associate with this Azure Repos integration. This allows you to manage different branches across project stages.

  5. Save Configuration

    • After filling out the necessary fields, click Save to apply your Azure Repos integration settings.

Example Configuration​

Below is an example of what the Azure Repos configuration fields might look like when filled out:

Azure Repository: my-azure-repo
Azure Organization: my-org
Azure Branch: main
Project: my-project
User: azure-user
Personal Access Token: [securetoken]

Configuring Bitbucket Integration​

The Bitbucket configuration page in the Digisquares platform allows users to connect their projects to Bitbucket repositories. This setup provides seamless version control and repository management directly within Digisquares.

To set up Bitbucket as your source control integration, follow the steps below. These instructions include fields for repository information, branch details, and access credentials.

Step 1: Select Source Control Platform​

  • Go to the Source Control settings page.
  • Click on the Bitbucket tab to configure Bitbucket as your source control provider.

Step 2: Set Up Repository Configuration​

  1. Bitbucket Username: Enter your Bitbucket username associated with the repository.
  2. Bitbucket Workspace: Provide the name of the Bitbucket workspace that contains the repository.
  3. Bitbucket Repository: Input the name of the Bitbucket repository you wish to connect to your project.
  4. Bitbucket Branch: Specify the branch to link (e.g., main, dev).
  5. Bitbucket URL (optional): Enter the URL of the Bitbucket repository if applicable.
  6. Bitbucket Enterprise API URL (optional): If you are using Bitbucket Enterprise, provide the API URL for integration.

Step 3: Access Configuration​

For secure access to your Bitbucket repository, you’ll need to configure authentication details.

  1. Bitbucket App Password: Paste the Bitbucket app password, which provides access to the repository for integration purposes.

Step 4: Select Deployment Stage​

Choose the deployment stage (Development, Testing, or Production) that you want to associate with this Bitbucket integration. This enables you to manage the deployment flow and promote changes through different stages of the project lifecycle.

  1. Select Stage: Use the dropdown menu to select the appropriate stage.

Example Configuration:​

Bitbucket Username: my-bitbucket-username
Bitbucket Workspace: my-workspace
Bitbucket Repository: my-repo
Bitbucket Branch: main
Bitbucket URL: https://bitbucket.org/my-workspace/my-repo
Bitbucket Enterprise API URL: https://api.bitbucket.mycompany.com
Bitbucket App Password: [your-app-password]

Conclusion​

Integrating source control with the Digisquares platform allows for seamless version control and streamlined deployment management. Follow the setup instructions for each platform to enable continuous integration and deployment in your project.

tip

Ensure you store your access keys and tokens securely and periodically review access permissions to maintain project security.