Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Project Managers are the project administrators or maintainers of the project. They set up a project on EasyCLA, and manage configuration details, such as the GitHub organization or Gerrit instance or GitLab groups, and associated repositories. The Project Manager uses the Project Control Center for these actions.
As a Project Manager, you can perform the following activities:
Add and manage GitHub organization or Gerrit organization or GitLab Groups
Additionally, you can view and manage CLA details, GitHub, Gerrit, and GitLab organizations and repositories:
For EasyCLA integrated GitHub organizations and repositories, EasyCLA sends email notification to project managers regarding any changes to the repositories. EasyCLA takes the following actions for different events:
Repository Renamed: EasyCLA updates GitHub repository table entry to match the new GitHub repository name, and notifies the project manager.
Repository Archived: EasyCLA takes no action, however notifies the project manager that the repository is archived.
Repository Deleted: EasyCLA disables the repository, and notifies the project manager.
Repository Moved to a Different Organization:
If an EasyCLA enabled repository is moved from one organization to another within the same CLA Group, EasyCLA simply notifies the project manager about the action.
If a repository is moved from one organization to another where EasyCLA is not configured or the CLA Group is different, EasyCLA disables the repository, and notifies the project manager.
A CLA Group defines:
What CLA types your project requires for pull requests or push submissions — corporate CLA (CCLA), individual CLA (ICLA), or both, What CLA templates are used for the CCLA and/or ICLA, What GitHub repositories, Gerrit instances, or GitLab groups are enforced for CLA mechanism
A single CLA Group includes a pair of CCLA and ICLA templates, if both types are enabled for that CLA Group.
1. Sign in to the Project Control Center.
2. Under My Projects, click a project or search the project from the search bar for which you want to create a CLA group.
3. From left-side navigation, Navigate to LFX Tools > EasyCLA.
4. Click +Add New CLA Group.
Note: For the current v2 release, a single project can have only one CLA Group. If you have already created a CLA Group for that project, or for a parent of that project, the +Add New CLA Group button will be disabled and you will not be able to create another CLA group for that project.
5. Under CLA Group Name tab, provide a CLA group name and a brief description in the respective fields.
Note: Click the help icons (?) to know more about a field or check box.
6. Select the check boxes as applicable to the contributors of a project, and click Next.
A warning message appears if you select only one. Most projects will enable contributions under a CCLA as well as an ICLA.
If you only select Corporate CLA, then only corporate employees can sign and contribute to your project.
If you only select Individual CLA, then only individuals can sign and contribute to your project.
7. Under Edit/Review Template tab, review the project name, project full entity name. If these are not correct, stop and do not proceed. Check the Project object database settings and contact the LF legal team at legal@linuxfoundation.org if you have questions.
8. Then, select a template from Template drop-down. and provide appropriate point of contact in the Email Address of Person Managing Project field. This will be filled into the CLA templates as the email address for contributors to submit signed CLAs if they want to sign them manually, rather than via DocuSign.
Note:
If you want to use a different template than the ones listed, create a support ticket with the correct CCLA and ICLA templates that your project will use.
Both the available templates are standard CCLA / ICLA pairs that are used by several projects on EasyCLA. These templates are derived from the Apache Software Foundation's CLAs and Academy Software Foundation's CLAs, but are not identical to either of them.
9. Review the generated CCLA and ICLA templates. If the filled-in values or other contents of the template do not look correct, stop and do not proceed. Contact the EasyCLA support team by filing a support ticket if you need assistance.
10. If the Project for which you are creating the CLA Group has no subprojects, then click Finish and skip the next step.
11. If the Project for which you are creating the CLA Group does have subprojects, then click Next. Under the Select Projects tab, select the projects that you want to enroll under the CLA group, and click Finish.
Note: As mentioned above, for the initial v2 release, a single project can only have one CLA Group. If you have already created a CLA Group for that project, or for a parent of that project, the +Add New CLA Group button will be disabled and you will not be able to create another CLA group for that project.
Project managers can edit and update CLA templates to display the correct email address of the person managing the project so that contributors can submit signed CLAs to the mentioned email addresses if they want to sign them manually, rather than via DocuSign.
1. Sign in to the Project Control Center.
2. Under My Projects, click a project, and scroll down to Tools Status section, and click EasyCLA.
3. Under CLA Groups, select a CLA group for which you want to update templates.
4. Navigate to TEMPLATES tab, and click Edit Template.
5. Provide email address of the person managing the project in the respective field, and click Update Template.
Note: This email address is displayed in the CLA templates as the email address for contributors to submit signed CLAs if they want to sign them manually, rather than via DocuSign.
6. Click Update Template.
Before you can add or manage GitHub organizations and repositories, you must connect or add GitHub organizations while setting up IT services. However, you can also add GitHub organization in the GitHub pane of Tools tab.
After you successfully add GitHub organization, you can:
Prerequisite: You must be the owner of the GitHub organization which you want to connect for CLA mechanism.
1. Sign in to the Project Control Center.
2. Click a project of interest.
3. Scroll down to the Tools Status section, and click EasyCLA.
Note: You can also connect the GitHub organization during IT set up in the IT Services Status section, and then install EasyCLA application in Tools Status section to add it for CLA process.
4. Under CLA Groups, select a CLA group to which you have added the project.
5. Click Manage next to the project for which you want to manage repositories.
6. Under the GitHub tab, click the + sign at the top right of Add GitHub Organization.
7. Type the GitHub organization name in the Enter GitHub Organization field, and click Connect.
8. Click Install GitHub EasyCLA App.
9. Sign in to GitHub if the sign-in window appears, and click Configure.
10. Select the organization that you want to enroll for CLA mechanism.
11. Select repositories, and click Install.
Note:
If you select Only select repositories, then a newly added repository to the GitHub organization will not be reflected automatically under the project's GitHub organization page in Project Console.
12. Navigate to the Project Control Center, and click I'm Done Installing.
Important: To enable a CLA mechanism on a repository, you must enforce CLA mechanism for GitHub repositories. Simply adding a GitHub organization to the project does not enable the EasyCLA mechanism for any CLA groups.
After adding the GitHub organization, you should enable branch protection and auto enable new repositories.
Enable Branch Protection automatically enables the EasyCLA check for all the branches of the GitHub organization. If you select this check box, you do not need to enable branch protection manually.
Auto Enable New Repositories automatically adds a repository under the GitHub organization on the project console when you add the repository to the GitHub organization.
2. Click both the check boxes, and click Save Changes.
2. Click Disassociate GitHub Org, and click the link to create a support ticket to disassociate the GitHub org.
A Project Manager can sign in to the EasyCLA Project Control Center to perform the CLA set-up and management tasks for projects that you manage.
To Sign in:
Click Sign in with SSO.
Enter your credentials as the Project Manager and click Sign In.
4. Click a project to view more about the project or search for a project from the left navigation pane. For details, see View Project CLA Details.
Before you enable Git repositories for CLA check or remove them from CLA mechanism, you must add the or or organizations. You can perform the following activities with EasyCLA:
1. Sign in to the .
2. Click a project of interest.
3. From Tools Status drop-down menu, click EasyCLA.
4. Select the CLA group to which you have added the project.5. Click Manage next to the project for which you want to manage repositories.
Under GitHub, select the added organization for which you want to manage repositories.
Turn on or turn off the Enforce CLA toggle key to enforce or remove all the repositories from CLA mechanism at a time.
To enforce CLA for individual repositories, select the check box next to a repository, and click Save.
Under GitLab, select the added group for which you want to manage projects.
Turn on or turn off the Enforce CLA toggle key to enforce or remove all the projects from CLA mechanism at a time.
To enforce or remove CLA from individual projects, turn on the toggle key next to a project, and click Yes.
Project Managers can anytime invalidate a contributor's signature for any valid reason, for example when a contributor leaves the organization.
Sign in to the .
Click a project name of interest.
Scroll down to Tools Status section, and click EasyCLA. The EasyCLA Overview page appears.
Navigate to Signatures tab.
From Signed ICLAs tab, under Actions column, click Invalidate .
Click Invalidate again on the window that appears.
The Project Manager can add new projects to a CLA group or remove projects from a CLA group.
Sign in to the .
Under My Projects, click a project.
Scroll down to Tools Status section, and click EasyCLA.
Under CLA Groups, select a CLA group for which you want to manage projects.
Select or deselect the check box next to a project to add or remove the project from the CLA group.
Click Update CLA Group.
Note: A project's check box is selected and unavailable under a CLA group if the project has already been added to another CLA group.
Before you can add or manage Gerrit organizations and repositories, you must connect or add Gerrit organizations while setting up IT services. However, you can also add Gerrit organization in the Gerrit pane of Tools tab.
After you successfully add Git organizations, you can:
Note:
If you have already added a Gerrit instance during the EasyCLA on-boarding process, skip this procedure unless you want to add more Gerrit instances.
After you add a Gerrit organization, all of its repositories are EasyCLA-enabled by default.
1. Click the + sign at the top right of Add Gerrit Organization.
2. Complete the form fields, and click Connect.
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 team to get Gerrit Instance Name and URL.
Contact the Linux Foundation IT team 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 EasyCLA project console lists the CLA-enabled instances, as shown below.
Note: You cannot disable the CLA check for individual Gerrit repositories.
1. Click Disassociate Gerrit next to a Gerrit Instance, and click Yes, Disconnect on the confirmation page.
1. Click the settings icon next to Additional Settings for a GitHub organization.
1. Click the settings icon next to Additional Settings for a GitHub organization.
After you add a , by default all of its repositories are CLA enabled. You cannot disable CLA for an individual Gerrit repository. However, you can to disable CLA for the organization and all of its repositories.
Before you can add or manage GitLab groups and projects, you must connect or add GitLab groups while setting up IT services. However, you can also add GitLab groups in the GitLab pane of Tools tab.
Note:
In GitLab, organizations are mentioned as groups, and repositories are mentioned as projects.
You must be the owner of the GitLab group which you want to connect for CLA mechanism.
After you successfully add Git organizations, you can:
1. Sign in to the Project Control Center.
2. Click a project of interest.
3. Scroll down to the Tools Status section, and click EasyCLA.
Note: You can also connect the GitLab groups during IT setup in the IT Services Status section, and then install the EasyCLA application in the Tools Status section to add it for the CLA process.
4. Under CLA Groups, select a CLA group to which you have added the project.
5. Click Manage next to the project for which you want to manage repositories.
6. Under the GITLAB tab, click the + sign at the top right of ADD GITLAB GROUP.
7. Provide the complete URL of the GitLab group, as shown in the image, in the Enter GitLab Group URL field, and click Connect.
8. Click Install GitLab EasyCLA App.
9. Click Authorize.
10. Installation Successful window appears. Close the window, navigate to the Project Control Center, and click I'm Done Installing.
Note: If you do not click I'm Done Installing, you will have to reinstall EasyCLA application.
Note:
1.LFX EasyCLA adds all the projects, including projects under subgroups, of the GitLab group to the Project Control Center.
2.To enable a CLA mechanism on a project, you must enforce CLA mechanism for GitLab projects. Simply adding a GitLab group to the project does not enable the EasyCLA mechanism for any GitLab project.
3.To review the configuration or revoke the application, navigate to the GitLab Applications under your User Settings.
After adding the GitLab group, you should enable branch protection and auto enable new repositories.
Enable Branch Protection automatically enables the EasyCLA check for all the branches of the GitLab group. If you select this check box, you do not need to enable branch protection manually.
Auto Enable New Repositories automatically adds a repository under the GitLab group on the project console when you add a project to the GitLab group.
To enable branch protection and auto enable new repositories:
2. Click both the check boxes, and click Save Changes.
Note: To disassociate a GitLab group, you must disable CLA from all projects of the GitLab group.
Click Disassociate GitLab Group, and click Disassociate on the confirmation window.
Prerequisite: You must be an owner of the GitHub organization.
If you uninstall the EasyCLA application from a GitHub organization, EasyCLA monitoring is no longer in effect for the organization and all of its the repositories.
Sign in to GitHub, and navigate to the organization for which you want to uninstall the EasyCLA application.
Under Settings tab, select Installed GitHub Apps from the left side navigation pane.
Click Configure for the Linux Foundation: EasyCLA app.
4. Navigate to Danger zone > Uninstall Linux Foundation: EasyCLA section, and click Uninstall.
5. Refresh the Project Control Center.
After you add a GitHub or Gerrit organization or GitLab group, the organizations or groups are displayed with different colors referring to their connection statuses. The following is an example:
indicates full connection: all the repositories of the organization are connected.
indicates partial connection: some repositories of the organization are connected.
indicates no connection: the organization is added, but its repositories are not .
indicates connection failure: for a connected organization, either the EasyCLA configuration is uninstalled or the organization is deleted from GitHub/Gerrit/GitLab.
A repository with a cross mark next to it indicates connection failure. It means the repository was EasyCLA enabled, but it is deleted from the organization.
Important: Before you get started, make sure your project meets the .
As a project manager, do these steps to get access to EasyCLA:
If you do not have an LF Single Sign-on account, before you proceed further.
Share your username with the EasyCLA administration team at .
Provide sample ICLA and CCLA template documents to the CLA administration team at .
After the CLA administration team confirms your setup, you can Sign In to the to do the EasyCLA activities as .
Note: CCLA managers can immediately start using the EasyCLA Corporate Console because it does not require activation from the EasyCLA administration team. to do the EasyCLA activities.
1. Click the settings icon next to Additional Settings for a GitLab group.
Click the settings icon next to Additional Settings for a GitLab group.
A Project Manager can view CLA group details and update CLA group details by updating or deleting a CLA group name, updating a CLA template, and invalidating a contributor's signature.
Sign in to the Project Control Center.
Click a project name of interest.
Scroll down to the Tools Status section, and click EasyCLA. The EasyCLA Overview page appears.
The Overview page displays CLA groups that have been added to the project, details for each CLA group, and an activity log table. A CLA group defines a CCLA and/or ICLA that contributors must sign.
1. Name of the CLA group, and whether the CLA Group includes a CCLA and/or an ICLA with a tick mark beside each CLA type.
Projects Covered shows the number of projects covered under the CLA group.
Repositories show the total number of repositories of the added projects that are enrolled for CLA monitoring. You must enforce EasyCLA for one or more Git repositories for them to be counted.
Signatures shows the number of individuals who have signed CLA within that CLA group, and whose signature status is in active state. This includes both ICLA and/or CCLA based on the CLA group configuration.
Click the pencil icon to edit the title and description of the CLA group.
2. Under the PROJECTS tab, expand the project group to view projects that are enrolled for the CLA group. Inactive selected check boxes indicate that the project has already been added to another CLA group. Click Manage to add and manage GitHub, Gerrit, or GitLab groups and repositories.
3. Navigate to the TEMPLATES tab to view and download the ICLA and/or CCLA templates. You can update the templates in case the email address mentioned in the template is not correct or you want to change it.
Navigate to SIGNATURES tab to view signed ICLAs and CCLAs.
Signed ICLAs lists details of individuals who have signed an ICLA, such as name, LF Login name (LF ID), GitHub ID, email address, status of their signature (Active, Disabled, Invalidated), and Invalidate CTA under Actions column (enabled only for Active statuses). Following are the different signature statuses:
Active: The contributor has completed the CLA signing process.
Incomplete: The contributor has not completed the CLA signing process.
Disabled: Either the project manager has invalidated the signature of the contributor or the CLA manager has removed the contributor's approved criteria from the approved criteria list on the corporate CLA console.
Signed CCLAs list the details of companies that have signed a CCLA. It lists the company name, CLA Managers, approved contributors, approval criteria for the approved contributors, the signed CCLA document, and the date.
It shows the recent CLA activities for the projects within the CLA group, such as activity description, name of the person who did the activity, date and time of the activity, the corresponding company name where applicable, and the applicable project.
Clickto create a support ticket requesting to delete the CLA group.