Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EasyCLA provides "Checks" tab in PR #204

Closed
jpalmerLinuxFoundation opened this issue Sep 16, 2019 · 2 comments · Fixed by #598
Closed

EasyCLA provides "Checks" tab in PR #204

jpalmerLinuxFoundation opened this issue Sep 16, 2019 · 2 comments · Fixed by #598
Assignees
Labels
03 - Med Medium Priority enhancement New feature or request GitHub Integration v2

Comments

@jpalmerLinuxFoundation
Copy link
Contributor

jpalmerLinuxFoundation commented Sep 16, 2019

Summary
The projects would like a way to understand better why the CLA check is failing.
Which of the contributors is NOT covered by a signed CLA?

Background
Scenario: CLA check fails: Not whitelisted

  1. Go to a repo with EasyCLA configured, and you have NOT signed CLA covering you (ICLA or CCLA)
  2. Create a PR
  3. When the PR fails, click on the "Checks" tab of the PR
  4. Check Run completes with the following displayed: (ref: https://developer.github.com/v3/checks/runs/)
  • Status: Completed
  • Conclusion: Action Required
  • Annotations: Failure
  • Filename: [filename]
  • Title: "EasyCLA: Signed CLA not found"
  • Message: "One or more committers are authorized under a signed CLA."
  • Raw Output: "[email@address.com] is not authorized under a signed CLA."

Scenario: CLA check fails: whitelisted

  1. Go to a repo with EasyCLA configured, and you have NOT signed CLA covering you (ICLA or CCLA)
  2. Create a PR
  3. When the PR fails, click on the "Checks" tab of the PR
  4. Check Run completes with the following displayed: (ref: https://developer.github.com/v3/checks/runs/)
  • Status: Completed
  • Conclusion: Action Required
  • Annotations: Failure
  • Filename: [filename]
  • Title: "EasyCLA: Signed CLA not found"
  • Message: "One or more committers are authorized under a signed CLA."
  • Raw Output: "[email@address.com] must confirm corporate affiliation."

User Story
As a project maintainer and committer
I need to see why the CLA is failing
so that I can effectively troubleshoot the issue and sign if necessary.

Tasks

  1. Update EasyCLA App Permissions (https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#step-11-updating-app-permissions)
  2. Add Event Handling (https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#step-12-adding-event-handling)
  3. Create Check Run (https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#step-13-creating-a-check-run)
  4. Enable check run updates (https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#step-14-updating-a-check-run)
  5. Review and implement appropriate Security (https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)

Acceptance Criteria
The "done" criteria when this feature or problem is resolved. Such as:

  1. Unit Tests added and running in CI
  2. Functional Tests updated to cover feature, if applicable
  3. Demonstrate the set of capabilities to the product team while the code is
    running in the STAGING environment.

References

  1. https://developer.github.com/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/
  2. https://developer.github.com/v3/checks/
  3. EasyCLA PR: User-Email Level Signature Details #169
  4. CLAbot is lacking logs  cncf/foundation#26
  5. Open source CLAbot cncf/foundation#3

image

@jpalmerLinuxFoundation
Copy link
Contributor Author

@dealako, please create a ticket and reference this one as prep for this development

@ngozi-ekekwe
Copy link
Contributor

ngozi-ekekwe commented Feb 18, 2020

@pranab-bajpai @dealako. I need to clarify what to put under Filename: [filename] and context

cc @wanyaland

wanyaland added a commit to wanyaland/easycla that referenced this issue Feb 24, 2020
- Created checks tab in case of check fails
- Handle invalid github ids

Resolves: communitybridge#204

Signed-off-by: Harold <wanyaland@gmail.com>
dealako added a commit that referenced this issue Feb 24, 2020
- Created checks tab in case of check fails
- Handle invalid github ids

Resolves: #204

Signed-off-by: Harold <wanyaland@gmail.com>

Co-authored-by: David Deal <dealako@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
03 - Med Medium Priority enhancement New feature or request GitHub Integration v2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants