Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
As a project manager, you have responsibilities to manage a project’s GitHub organization or Gerrit instance, members, repositories, and legal aspects like the CLA. You use the CLA Management Console to set up CLA.
To Set Up CLA:
​Add a CLA Group.
At any time, you can change the settings to manage your project's CLA monitoring, and do other management tasks:
​Manage CLA Group Details​
Project managers sign in to the EasyCLA Management Console to perform the CLA set-up and management tasks.
1. Go to https://easycla.lfx.linuxfoundation.org/
2. On Projects card, click Proceed.
3. Enter your credentials as the project manager, and click SIGN IN.
Result: The CLA Management Console appears and lists your assigned projects from the Linux Foundation, for example:
4. Click a project name of interest.
For each project, the CLA Management Console provides the following information:
GitHub Organizations shows the organizations to which you have connected to the CLA Management Console. Organizations are shared accounts where companies and open source projects can collaborate across many projects at once.
CLA Groups shows the CLA groups that you have added to the project. A CLA group defines one or more CLA types that contributors must sign.
GitHub Repositories shows the repositories that you have configured to require CLA monitoring for pull requests.
Gerrit Instances shows the Gerrit instances that you have added to require CLA monitoring for pushes.
As a project manager, you use the CLA Management Console to:
Add one or more Gerrit instances to CLA monitoring
Integrate the Gerrit repositories so you can monitor all the code submissions that contributors make
Delete Gerrit instances from CLA monitoring as required
If you already added a Gerrit instance during the CLA onboarding process, skip this procedure unless you want to add more Gerrit instances.
To add or remove Gerrit Instances:
1. Sign in to the CLA management console.
2. Click a project of interest
3. Click ADD GERRIT INSTANCE ****The Add Gerritt Instance form appears.
4. Complete the form fields, and click SUBMIT. Gerrit Instance Name - Name of the Gerrit Instance Gerrit Instance URL - URL of the Gerrit Instance ICLA Group ID - An existing LDAP Group ID for Individual CLAs CCLA Group ID - An existing LDAP Group ID for Corporate CLAs
Notes:
Contact the Linux Foundation IT if you do not know the LDAP Group IDs.
One or both LDAP groups must exist for you to be able to create a Gerrit instance. If a group does not exist, an error message appears and you are prevented from creating a Gerrit instance.
The CLA Management Console lists the instance under Gerrit Instances.​​
The CLA Management Console presents a CLA block of code:
[contributor-agreement "{ICLA-Name} “]
description = ICLA for Linux Foundation
agreementUrl = {URL }
accepted = group {Group-Name}
[contributor-agreement "{CCLA-Name} “]
description = CCLA for Linux Foundation
agreementUrl = {URL }
accepted = group {Group-Name}
5. Copy the block. As the Gerrit instance administrator, you will modify CLA configurations for the following files under the Gerrit instance’s All-Projects repository. If you are not the administrator, contact the Gerrit instance administrator to include the following files under the Gerrit instance’s All-Projects repository. Projects are organized hierarchically as a tree with the All-Projects project as root from which all projects inherit.
You can get and set the configuration variables by using the git config command with the -l option (this option provides the current configuration), or if you are using the Gerrit web interface, go to Projects and click List. Select your project and click Edit Config.
project.config - Add the contributor license agreement block to this project configuration file. This is the project configuration file across all repositories of the Gerrit instance. At the end of the file, replace the variables with your project CLA values and then save the file:
[contributor-agreement "{CLA-Name} “]
description = CLA for Linux Foundation
agreementUrl = {URL }
accepted = group {Group-Name}
CLA-Name can be a name of your choosing. The name must include the double quotes.
URL** ** refers to the URL to the CLA Contributor Console.
Group-Name should be an existing Group Name, under the Group section of the Gerrit instance. This name refers to the LDAP Group that the user will be added to.
groups - If the Group-Name value that you specified in the project.config file does not exist in this file, add it to this file, and then save the file.
Provide these files and Gerrit configuration to the Linux Foundation Release Engineering team to finish configuration. The CLA Management Console shows the repositories that the CLA application will monitor.
6. To delete an instance from monitoring, click DELETE next to the instance that you want to delete. A confirmation dialog appears. Click DELETE.
As a project manager, you can add GitHub repositories to CLA monitoring or remove them from CLA monitoring.
To add or remove Github Repo:
1. Sign in to the CLA management console.
2.Click a project of interest.
3. In the GitHub Repositories pane, click CONFIGURE GITHUB REPOSITORIES.
The Configure GitHub Repositories dialog appears and lists the GitHub repositories that are available for your organization.
4. For the repository that you want to configure, click an option:
ADD adds the repository to the CLA group and to CLA monitoring. After you add a repository, the REMOVE option becomes available next to the repository.
REMOVE disables CLA enforcement on the repository. After you remove a repository, the ADD option appears next to the repository.
REMOVE removes the repository from the CLA group and CLA monitoring. After you remove a repository, the ADD option appears next to the repository.
DISABLED indicates that the repository has been configured for another CLA group and thus cannot be configured for the selected CLA group.
ADD ALL REPOS adds all repositories for the corresponding GitHub Organization to CLA enforcement. After you add the repositories the REMOVE option appears next to each repository.
5. Click CLOSE.
The CLA Management Console appears. Repositories shows a checkmark next to each repository that EasyCLA will monitor for the organization and the CLA group.
A CLA group defines:
What CLA types your project requires for pull requests or push submissions—the agreement types are for corporate or individual CLAs
What CLAs and their versions are used for the contributors
What GitHub repositories, Gerrit instances, or both enforce CLA monitoring
A CLA group gives you the flexibility to handle different CLA requirements for various GitHub repositories and Gerrit instances.
To Add a CLA Group:
1. Sign in to the CLA management console.
2. Click a project of interest. The project page appears. A message informs you that your project needs a CLA group. A CLA group defines one or more CLA types that contributors must sign before they can contribute to a project.
3. Click ADD CLA GROUP.
4. Complete the dialog options:
5. Enter a CLA Group Name. The CLA Group Name indicates that a project has one or more CLAs (Individual CLA, Corporate CLA, or both). Consider matching the CLA group name to the project name for easy identification.
6. Select the CLA types that you want applied to contributions to the project:
Corporate CLA: to be signed by a company - This Corporate CLA must be signed by the CCLA signatory for your company. This person has authority to enter into legal contracts on behalf of the corporation.
Individual CLA: to be signed as an individual contributing - A developer who is not contributing on behalf of any company signs this Individual CLA. This individual is contributing to a project on their own behalf. Selecting this type automatically enables the "Contributors under Corporate CLA must also sign Individual" CLA type.
Contributors under Corporate CLA must also sign Individual CLA - Employees (developers) of a company use this agreement. A Corporate CLA may not remove the need for every employee to sign their own Individual CLA as an individual. This option covers both owned contributions and not-owned contributions by the corporation signing the Corporate CLA.
7. Click SAVE.
The CLA group that you added and the CLA types that you specified appear under CLA Groups.
(Optional) Manage CLA Group Details
The CLA Management Console lets you select and view the current CLA PDF and previous CLA PDFs for your project.
To view CLA PDFs:
1. Sign in to the CLA management console
2. Click a project of interest.
3. Go to the CLA group that has the CLA PDF that you want to view.
5. Click the PDF icon next to the version that you want to view.
6. Click View PDF.
The PDF opens in a new window.
As a project manager, you can uninstall the EasyCLA Application for a GitHub organization. When you uninstall the app, it is removed from all your repositories. CLA monitoring is no longer in effect.
To Uninstall:
1. Sign in to GitHub, and navigate to the organization for which you want to uninstall the EasyCLA application.
2. Under Settings tab, select Installed GitHub Apps from the left side navigation pane.
3. Click Configure for the Linux Foundation: EasyCLA app.
4. Navigate to Danger zone > Uninstall Linux Foundation: EasyCLA section, and click Uninstall.
5. Refresh the CLA Management Console.
The EasyCLA Application is uninstalled.
As a project manager, you use the CLA Management Console to manage your CLA group details, and view user signatures and companies.
To manage CLA groups:
Sign in to the CLA management console
Click a project of interest.
Do any of the following actions:
You can change your CLA type selections if needed.
The CLA Group dialog appears and shows your current CLA type selections.
2. Change the CLA Group Name, selections, or all, and click SAVE.
You can view the full set of signatures and list of approved contributors who are interacting with a project. A signature list shows details about who signed a CLA for your project.
1. Click VIEW SIGNATURES.
Details for all user signatures appear:
Type shows Company, Individual, or Employee depending on the CLA type that the user signed.
Name identifies the individual or employee who signed the CLA.
Company identifies the company that is associated with a Corporate CLA.
GitHub ID shows the GitHub identity of the individual or employee.
LFID shows the Linux Foundation identity of the individual or employee.
Version identifies the version of the CLA.
Date Signed shows the date that the individual, employee, or CLA signatory signed the CLA.
2. (Optional) Click a column header to sort the column values in ascending or descending order. Use the pagination options to go to subsequent or previous pages.
3. Click CLOSE.
The Corporate CLA list lets you see what companies in your project have a signed Corporate CLA.
1. Click VIEW COMPANIES on a Corporate CLA.
All companies that have signed the Corporate CLA are listed.
2. Click CLOSE.
4. Click the PDF icon . The CLA PDF dialog appears and shows the current CLA PDF and previous CLA PDFs.
1. Click the gear icon next to the CLA group name.
The EasyCLA Application installation process connects GitHub to the CLA Management Console. After you complete installation, you must configure the repositories to enforce CLA monitoring.
To Install the EasyCLA Application:
1. Sign in to the CLA management console.
2. Click a project of interest.
3. Click CONNECT GITHUB ORGANIZATION. The Add GitHub Organization dialog appears and lets you specify the GitHub organization.
Connecting your GitHub organization will let you enable EasyCLA checks on that organization. If you already have a CLA process in place, go to the Linux Foundation Support Center, fill the form, and click Create to file a ticket to describe your particular needs, and import your existing CLAs.
4. Enter your organization name in the GitHub Organization URL field. The URL automatically appends the name. Click CONNECT.
Result: The Connect LF CLA App to GitHub Organization dialog appears.
The GitHub organization name value is case-sensitive—make sure that the name you enter matches the case of your GitHub organization name exactly.
5. Read the instructions and click INSTALL THE GITHUB CLA APP. ​The EasyCLA Application opens in GitHub
6. Click Install on the EasyCLA Application.
7. Select one or more repositories and assign permissions. Click Install.
The CLA Management Console appears and the GitHub Organizations pane shows the organizations and the repositories that the EasyCLA Application is authorized to monitor.
To delete an organization from monitoring, click DELETE next to the organization that you want to delete. A confirmation dialog appears. Click DELETE. You must also Uninstall LF CLA Application for Your Organization that you installed in Step 5.
A message informs you that your project needs a CLA group. A CLA group defines one or more CLA types that contributors must sign.
If the EasyCLA Application is not connected to GitHub properly, an error message appears under the organization name: Not Configured. Please connect the CLA App to the Github Org. Click the message link to return to Step 4.
8. Repeat Steps 2 through 7 to connect as many organizations as you want.
Important: To enable a CLA check on a repository, you must configure a GitHub repository or add a Gerrit instance. Simply adding an organization to the project does not enable the CLA check for any CLA groups.
The CLA Management Console lets you select a template style to use for your Corporate CLA and Individual CLA.
In some circumstances, you need to change the legal text of the CLA agreement in major and minor revisions:
A major revision (for example, a change to your charter) is one in which you are legally required to have all contributors re-sign the revised agreement.
A minor revision is one that does not change a legal perspective and contributors do not need to re-sign the revised agreement.
In these cases, you simply add the updated CLA using the same procedure as for adding the initial CLA.
Verify that the pop-up blocker is disabled on your browser before you begin this procedure.
To Add CLA:
1. Sign in to the CLA management console.
2. Click a project of interest.
3. Go to the CLA group to which you want to add a CLA and click SELECT TEMPLATE. The Select a template page appears and lists available templates.
4. Click the button on the template you want to use.
A template information form appears. The information you enter in this form will populate the corresponding fields in the resulting Corporate CLA and Individual CLA PDFs. The following form is an example; each form is specific to the project.
5. Complete the form fields and click GENERATE AND REVIEW PDFS. The CLA appears.
6. Click VIEW CCLA (Corporate CLA) or VIEW ICLA (Individual CLA) to view the respective PDF and scroll through the content to review it.
7. Click DONE. (BACK TO TEMPLATE INFORMATION returns you to the template form.)
The Projects page shows that you have successfully uploaded the Corporate CLA and Individual CLA templates under your CLA Group. Refresh the page if the templates do not appear.
(Optional) View Current and Previous CLA PDFs