Source Control

Source control is a critical component of software development, enabling teams to track and manage updates to their codebase.

Key Features:

• Track and manage updates to your codebase

• Maintain control over the right version of your code

• Collaborate with team members and stakeholders efficiently

Compliance Requirements:

• The Linux Foundation platform requires access to each GitHub organization hosting your code

Responsibilities

The governance body and authorized community members are responsible for day-to-day administration of repositories, teams, and users, unless covered by a specific managed-services agreement with the Linux Foundation.

You can add the following Source Controls tools to your projects:

• GitHub

• GitLab

• Gerrit

Setting up GitHub

GitHub is a web and cloud-based service that helps developers to store and manage their code, as well as to track and control changes to their code base.

You can use GitHub as a source control tool to manage your project.

To connect the GitHub account to the PCC, perform the follow steps:

1. Log in to PCC.

2. Search for the required project. The Project dashboard appears. Click Source Control from the Development tab.

You can also navigate to Source Control from the Vertical Sidebar navigation menu. Click IT Services and then select Development.

Source Control

1. The Source Control page appears. Click GitHub and click the icon available in front of Connect.

GitHub

1. The Connect GitHub Organization dialog box appears. Enter the Organization Name and click Connect.

Make sure to enter a valid GitHub organization name.

GitHub Organization Name

• For more information on how to create an organization, refer to Create an Organization.

• For more information on how to transfer a repository, refer to Transfer a Repository.

1. Once the connection is set, you can see the status of GitHub project and its repositories.

GitHub Status

If you change the name of your GitHub organization, you'll need to reconnect it to the PCC. The renamed organization won't be automatically connected, even if the original organization was previously connected.

Setup GitHub Repositories

You can manually add the repositories to the configured GitHub server.

To add repositories to the GitHub server, perform the following steps:

1. Go to the GitHub server in the Source Control and click + Add Repository.

Add Repository

1. The Add Repository dialog box appears. Enter the Repository Name, Website, and Description. Click Add to add the repository.

You can also enable the DCO, Issues and Wiki by using the Enable DCO, Enable Issues and Enable Wiki toggle button respectively.

Repository Details

Install the DCO app before enabling the DCO on the repository. Refer to GitHub DCO for configuration. After configuring the DCO in GitHub, you can enable the DCO in the PCC.

Enabling DCO in the PCC:

• Adds branch protection rules for the default branch, so that PRs must be made before changes can be merged.

• It adds a required DCO status check for PRs

If the DCO app is not installed and configured for the organization before DCO is enabled on a repository, all changes to the default branch will be blocked until the app is added.

Invite The Linux Foundation user to your Organization

Your project should have its own GitHub organization, separate from your company's GitHub organization, and which is not shared with other, non-Linux-Foundation projects.

If you need to, create a new GitHub organization for this project, and have a user who is an owner in both organizations transfer each project repository to this organization.

Then, invite the user “thelinuxfoundation” as an owner at the organization level (not per repository) to the GitHub organization, and connect them in Project Control Center.

• We cannot accept invites unless the organization is associated with a project. Please make sure to add the project to the PCC before sending an invite to 'thelinuxfoundation" user, or the invite will not be accepted and will expire after 7 days.

• For more information on how to invite users to join organization, refer Invite Users to an Organization.

• For more information on how to transfer a repository, refer Transfer a Repository.

If your invite has expired, you must delete it and send a new invite.

Deleting a GitHub Organization

You can delete the added GitHub organization from the PCC.

To delete the GitHub organization that is added in the PCC, follow these steps:

1. Click the Source Control.

2. Under GitHub, click on the required GitHub organization that you want to delete.

GitHub Organization

1. Click the icon and click Disassociate.

1. The Confirm Disassociation dialog box appears, click Delete to delete the GitHub Organization.

Delete

Setting up GitLab

GitLab is an open source code repository and collaborative software development platform for large DevOps and DevSecOps projects. GitLab helps you to automate the builds, integration, and verification of your code.

You can use GitLab as a source control tool to manage your project.

To setup the GitLab account to your project, perform the following steps:

1.Login into PCC.

2. Search for the required project. The Project dashboard appears. Click Source Control from the Development tab.

You can also navigate to Source Control from the Vertical Sidebar navigation menu. Click IT Services and then select Development.

Source Control

3.The Source Control page appears. Click GitLab and click the icon available in front of Connect.

GitLab

4.The Connect GitLab Group dialog box appears. Enter the Group Name and click Connect.

The name of the group should be added and not the url or the ID.

GitLab Group Name

5.Once the connection is setup, you can see the status of GitLab project and its repositories.

GitLab Status

Setting up Gerrit

Gerrit is a web-based code review tool, which is integrated with Git and built on top of Git version control system (helps developers to work together and maintain the history of their work). It allows merging changes to Git repository when you are done with the code reviews.

1.Login into PCC.

2. Search for the required project. The Project dashboard appears. Click Source Control from the Development tab.

You can also navigate to Source Control from the Vertical Sidebar navigation menu. Click Development and then select Source Control.

Source Control

3.The Source Control page appears. Click Gerrit and then click File Ticket to submit a ticket to configure Gerrit server for your project.

Gerrit

4. In the Support Form, provide details such as summary, project name, Gerrit URL and description. Click Create to submit the request to the support team.

Support Ticket

5.Once the support team configures the Gerrit server, the Gerrit server is added in the source control along with the associated repositories.

Gerrit

Adding Repositories

You can manually add the repositories to the configured Gerrit server.

To add repositories to the Gerrit server, perform the following steps:

1.Go to the Gerrit server in the Source Control and click + Add Repository.

Add Repository

2.The Add Repository dialog box appears. Enter the Repository Name and Description and click Add.

You can use the toggle button if you want to enable the repository as the parent repositories for other repositories.

Add Repository

Updating the Repository

You can update the repository name and other changes with respect to the listed repository.

To update the repository details, perform the following steps:

1.Go to the required repository and click the ellipsis icon and select Edit Repository.

Edit Repository

2.The Edit Repository dialog box appears. You can update the Repository Name, Enable DCO and Description and click Save to update the changes.

Repository Updates

Making a Repository as Writeable or Readable

You can set a repository as readable from writeable or from writeable to readable. To set the repository as readable or writeable, click the ellipsis icon and select Set Repository as Readable or Set Repository as Writeable.

When the repository is set as Writeable, the Read-only column is set as Yes and when the repository is set as Readable, the Read-only column is set to No.

Read and Write Access

Hiding a Repository and Restrict All Access

You can hide a repository and restrict all access to the repository by clicking the ellipsis icon and selecting the Hide Repository and Restrict All Access.

Hide Repository

Deleting a Repository

You can delete the listed repository by clicking the ellipsis icon and selecting the Delete Repository.

Delete Repository