Update check-cla to customize which CLA repo to use
#91
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,55 @@ | ||
| # Check CLA (Contributor License Agreement) | ||
|
|
||
| A custom GitHub action to be used in the conda GitHub organization for checking the | ||
| conda contributor license agreement. | ||
|
|
||
| ## GitHub Action Usage | ||
|
|
||
| In your GitHub repository include the action in your workflows: | ||
|
|
||
| ```yaml | ||
| name: Check CLA | ||
|
|
||
| on: | ||
| issue_comment: | ||
| types: [created] | ||
| pull_request_target: | ||
|
|
||
| jobs: | ||
| check: | ||
| if: >- | ||
| ( | ||
| github.event.comment.body == '@conda-bot check' | ||
| && github.event.issue.pull_request | ||
| || github.event_name == 'pull_request_target' | ||
| ) | ||
| steps: | ||
| - uses: conda/actions/check-cla | ||
| with: | ||
| # [required] | ||
| # A token with ability to comment, label, and modify the commit status | ||
| # (`pull_request: write` and `statuses: write` for fine-grained PAT; `repo` for classic PAT) | ||
| # (default: secrets.GITHUB_TOKEN) | ||
| token: | ||
| # [required] | ||
| # Label to apply to contributor's PR once CLA is singed | ||
| label: | ||
|
|
||
| # Upstream repository in which to create PR | ||
| # (default: conda/infrastructure) | ||
| cla_repo: | ||
| # Path to the CLA signees file within the provided `cla_repo` | ||
| # (default: .clabot) | ||
| cla_path: | ||
|
|
||
| # Fork of cla_repo in which to create branch | ||
| # (default: conda-bot/infrastructure) | ||
| cla_fork: | ||
| # [required] | ||
| # Token for opening singee PR in the provided `cla_repo` | ||
| # (`pull_request: write` for fine-grained PAT; `repo` and `workflow` for classic PAT) | ||
| cla_token: | ||
| # Git-format author/committer to use for pull request commits | ||
| # (default: Conda Bot <[email protected]>) | ||
| cla_author: | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,161 +3,196 @@ name: CLA check | |
| description: Reacts to new PRs and check if the contributor has previously signed the conda contributor license agreement (CLA). | ||
| inputs: | ||
| token: | ||
| description: >- | ||
| A token with ability to comment, label, and modify the commit status | ||
| (`pull_request: write` and `statuses: write` for fine-grained PAT; `repo` for classic PAT) | ||
| default: ${{ github.token }} | ||
| required: true | ||
| label: | ||
| description: Label to apply to contributor's PR once CLA is singed | ||
| required: true | ||
| cla_repo: | ||
| description: Upstream repository in which to create PR | ||
| default: conda/infrastructure | ||
| cla_path: | ||
| description: Path to the CLA signees file within the provided `cla_repo` | ||
| default: .clabot | ||
| cla_fork: | ||
| description: Fork of `cla_repo` in which to create branch | ||
| default: conda-bot/infrastructure | ||
| cla_token: | ||
| description: >- | ||
| Token for opening singee PR in `cla_fork` | ||
| (`pull_request: write` for fine-grained PAT; `repo` and `workflow` for classic PAT) | ||
| required: true | ||
| cla_author: | ||
| description: Git-format author/committer to use for pull request commits | ||
| default: Conda Bot <[email protected]> | ||
|
|
||
| runs: | ||
| using: composite | ||
| steps: | ||
| # if triggered by a comment, leave a reaction | ||
| - name: React to comment | ||
| uses: peter-evans/[email protected] | ||
| if: github.event_name == 'issue_comment' | ||
| with: | ||
| token: ${{ inputs.token }} | ||
| comment-id: ${{ github.event.comment.id }} | ||
| reactions: eyes | ||
|
|
||
| # commit status → pending | ||
| - name: Set commit status with pending | ||
| uses: conda/actions/set-commit-status@customize-cla-repo | ||
| with: | ||
| token: ${{ inputs.token }} | ||
| context: CLA check | ||
| description: Checking conda CLA... | ||
| state: pending | ||
|
|
||
| # has_label, number, contributor, url, has_signed | ||
| - name: Collect PR metadata | ||
| uses: actions/github-script@v6 | ||
| id: metadata | ||
| with: | ||
| github-token: ${{ inputs.token }} | ||
| script: | | ||
|
There was a problem hiding this comment. Could we add this to a separate javascript file? This is started to get long enough to warrant that, imo. There was a problem hiding this comment. Specifying these JS blocks in separate files requires: My problem with this is the checkout step which will make it harder to version our actions. There's an open request for something better: actions/github-script#326 There was a problem hiding this comment. It's a common pattern for actions to include all JS inlined, even if it's not great, let's follow that for now |
||
| const { owner, repo, number } = context.issue; | ||
| core.debug(`owner: ${owner}`); | ||
| core.debug(`repo: ${repo}`); | ||
| core.setOutput('number', number); | ||
| core.debug(`number: ${number}`); | ||
|
|
||
| const raw = await github.rest.pulls.get({ | ||
| owner: owner, | ||
| repo: repo, | ||
| pull_number: number | ||
| }); | ||
| const labels = raw.data.labels.map(label => label.name); | ||
| core.debug(`labels: ${labels}`); | ||
|
|
||
| const has_label = labels.includes('${{ inputs.label }}'); | ||
| core.setOutput('has_label', has_label); | ||
| core.debug(`has_label: ${has_label}`); | ||
|
|
||
| const { content, encoding } = (await github.rest.repos.getContent({ | ||
| owner: owner, | ||
| repo: repo, | ||
| path: '${{ inputs.cla_path }}' | ||
| })).data; | ||
| const contributors = JSON.parse( | ||
| Buffer.from(content, encoding).toString('utf-8') | ||
| ).contributors; | ||
| core.debug(`contributors: ${contributors}`); | ||
|
|
||
| const payload = context.payload.issue || context.payload.pull_request || context.payload; | ||
| const contributor = payload.user.login; | ||
| core.setOutput('contributor', contributor); | ||
| core.debug(`contributor: ${contributor}`); | ||
|
|
||
| const url = payload.html_url; | ||
| core.setOutput('url', url); | ||
| core.debug(`url: ${url}`); | ||
|
|
||
| const has_signed = contributors.includes(contributor); | ||
| core.setOutput('has_signed', has_signed); | ||
| core.debug(`has_signed: ${has_signed}`); | ||
|
Comment on lines
+53
to
+99
There was a problem hiding this comment. Moved Flattened logic since the error catching doesn't actually do anything special. Removes |
||
|
|
||
| # if contributor has already signed, add [cla-signed] label | ||
| - name: Add label to PR | ||
| uses: actions-ecosystem/[email protected] | ||
| if: steps.metadata.outputs.has_signed == 'true' && steps.metadata.outputs.has_label == 'false' | ||
| with: | ||
| github_token: ${{ inputs.token }} | ||
| labels: ${{ inputs.label }} | ||
|
|
||
| # if contributor has not signed yet, remove [cla-signed] label | ||
| - name: Remove label to PR | ||
| uses: actions-ecosystem/[email protected] | ||
| if: steps.metadata.outputs.has_signed == 'false' && steps.metadata.outputs.has_label == 'true' | ||
| with: | ||
| github_token: ${{ inputs.token }} | ||
| labels: ${{ inputs.label }} | ||
|
|
||
| # if unsigned, checkout cla_repo | ||
| - name: Clone CLA singee repo | ||
| uses: actions/checkout@v3 | ||
| if: steps.metadata.outputs.has_signed == 'false' | ||
| with: | ||
| repository: ${{ inputs.cla_repo }} | ||
|
|
||
| # if unsigned, update cla_path | ||
| - name: Add contributor as a CLA signee | ||
| shell: python | ||
| if: steps.metadata.outputs.has_signed == 'false' | ||
| run: | | ||
| import json | ||
| from pathlib import Path | ||
|
|
||
| path = Path("${{ inputs.cla_path }}") | ||
| signees = json.loads(path.read_text()) | ||
| signees["contributors"].append("${{ steps.metadata.outputs.contributor }}") | ||
| signees["contributors"].sort() | ||
| path.write_text(json.dumps(signees, indent=2)) | ||
|
|
||
| # if unsigned, create PR | ||
| - name: Create PR with new CLA signee | ||
| uses: peter-evans/create-pull-request@v4 | ||
| id: pull | ||
| if: steps.metadata.outputs.has_signed == 'false' | ||
| with: | ||
| push-to-fork: ${{ inputs.cla_fork }} | ||
| token: ${{ inputs.cla_token }} | ||
| branch: cla-${{ steps.metadata.outputs.contributor }} | ||
| delete-branch: true | ||
| commit-message: Adding CLA singee ${{ steps.metadata.outputs.contributor }} | ||
| author: ${{ inputs.cla_author }} | ||
| committer: ${{ inputs.cla_author }} | ||
| title: Adding CLA singee ${{ steps.metadata.outputs.contributor }} | ||
| body: | | ||
| Adding CLA signee @${{ steps.metadata.outputs.contributor }} | ||
|
|
||
| Xref ${{ steps.metadata.outputs.url }} | ||
|
|
||
| # if unsigned, create sticky comment | ||
| - name: Create comment regarding missing CLA signature | ||
| uses: marocchino/sticky-pull-request-comment@v2 | ||
| if: steps.metadata.outputs.has_signed == 'false' | ||
| with: | ||
| number: ${{ steps.metadata.outputs.number }} | ||
| # GitHub flavored markdown reinvents how paragraphs work, adjoined lines of text are not | ||
| # concatenated so instead we rely on YAML multi-line + extra newlines | ||
| message: >- | ||
| [cla]: https://conda.io/en/latest/contributing.html#conda-contributor-license-agreement | ||
|
|
||
|
|
||
| We require contributors to sign our [Contributor License Agreement][cla] and we don't | ||
| have one on file for @${{ steps.metadata.outputs.contributor }}. | ||
|
|
||
|
|
||
| In order for us to review and merge your code, please e-sign the | ||
| [Contributor License Agreement PDF][cla]. We then need to manually verify your | ||
| signature, merge the PR (${{ steps.pull.outputs.pull-request-url }}), and ping the bot | ||
| to refresh the PR. | ||
|
Comment on lines
+165
to
+176
There was a problem hiding this comment. @kathatherine this is the updated missing CLA message, is this good enough in light of conda/conda-docs#854 To see an example of this in action see conda-sandbox/test-check-cla#45 There was a problem hiding this comment. Hopefully the PR link will help with anyone who just reads to the CLA signing link and stops (like what happened with some of the PyCon sprinters I was working with). Maybe two links will encourage finishing the paragraph. :P This works for me. |
||
| GITHUB_TOKEN: ${{ inputs.token }} | ||
|
|
||
| # commit status → error | ||
| - name: Set commit status to error | ||
| if: steps.metadata.outputs.has_signed == 'false' | ||
| uses: conda/actions/set-commit-status@customize-cla-repo | ||
| with: | ||
| token: ${{ inputs.token }} | ||
| context: CLA check | ||
| description: Please follow the details link to sign the conda CLA. → | ||
| state: error | ||
| target_url: https://conda.io/en/latest/contributing.html#conda-contributor-license-agreement | ||
|
|
||
| # commit status → success | ||
| - name: Set commit status to success | ||
| if: steps.metadata.outputs.has_signed == 'true' | ||
| uses: conda/actions/set-commit-status@customize-cla-repo | ||
| with: | ||
| token: ${{ inputs.token }} | ||
| context: CLA check | ||
| description: CLA signed, thank you! | ||
| state: success | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.