Update `check-cla` to customize which CLA repo to use #91

kenodegard · 2023-04-03T21:03:02Z

Description

It is difficult to test the check-cla action since it's hardcoded with a specific repo to find the .clabot file. This updates the workflow to allow most of the hardcoded values to be customized.

Adds a new action set-commit-status to replace the unsupported https://github.com/Sibz/github-status-action (similar actions don't work for us, e.g., https://github.com/ouzi-dev/commit-status-updater).

See this in action here: https://github.com/conda-sandbox/test-check-cla

Xref #76

kenodegard · 2023-04-05T17:18:46Z

check-cla/action.yml

+ # if triggered by a comment, leave a reaction
+ - name: Comment Reaction
+ uses: peter-evans/[email protected]
+ if: github.event_name == 'issue_comment'
+ with:
+ token: ${{ inputs.token }}
+ comment-id: ${{ github.event.comment.id }}
+ reactions: eyes


Leaves a reaction on the @conda-bot check so we know the workflow is running (otherwise theres no indication the bot is working on it)

check-cla/action.yml

kenodegard · 2023-04-05T17:23:28Z

check-cla/action.yml

+ # commit status → pending
 - name: Set commit status with pending
- uses: dholth/github-status-action@runs-using-node16
+ uses: conda/actions/set-commit-status@customize-cla-repo
 with:
- authToken: ${{ inputs.token }}
+ token: ${{ inputs.token }}
 context: CLA check
 description: Checking conda CLA...
 state: pending
- sha: ${{ steps.pr.outputs.sha || github.sha }}



Switch to using our own custom set-commit-status since the third party options are poorly supported or don't do what we want.

check-cla/action.yml

kenodegard · 2023-04-05T20:32:08Z

check-cla/action.yml

+ # has_label, number, contributor, url, has_signed
+ - name: Collect PR metadata
 uses: actions/github-script@v6
- id: contributors
+ id: metadata
 with:
 github-token: ${{ inputs.token }}
 script: |
- console.log(context);
- const getContributors = async () => {
- try {
- const results = (
- await github.rest.repos.getContent({
- owner: 'conda',
- repo: 'infrastructure',
- path: '.clabot'
- })
- );
- return JSON.parse(Buffer.from(results.data.content, results.data.encoding).toString('utf-8')).contributors;
- } catch (err) {
- core.error(`Could not retrieve contributors, returning undefined. Reason: ${err}`)
- return undefined;
- }
- }
- const contributors = await getContributors();
- console.log(contributors);
- const pull_request = (context.payload.issue || context.payload.pull_request || context.payload);
- const creator = pull_request.user.login;
- console.log(creator);
- const hasSigned = contributors.includes(creator);
- console.log(hasSigned);
- core.setOutput('contributors', contributors);
- core.setOutput('hasSigned', hasSigned);
-
- # add [cla-signed] label if actor has already signed
- - name: Add label
+ 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}`);


Moved sha detection into new set-commit-status action. Removed labels output since we don't use it outside of this scope. Switch hasLabel to has_label for variable consistency.

Flattened logic since the error catching doesn't actually do anything special. Removes contributors output since we don't use it outside of this scope. Switch hasSigned to has_signed for variable naming consistency.

Good changes!

travishathaway · 2023-04-12T07:17:36Z

check-cla/action.yml

- core.setOutput('hasSigned', hasSigned);
-
- # add [cla-signed] label if actor has already signed
- - name: Add label


Could we add this to a separate javascript file? This is started to get long enough to warrant that, imo.

Specifying these JS blocks in separate files requires:

steps: - uses: actions/checkout@v3 - uses: actions/github-script@v6 with: script: | const script = require('./path/to/script.js') await script({github, context, core})

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

It's a common pattern for actions to include all JS inlined, even if it's not great, let's follow that for now

check-cla/README.md

jezdez · 2023-04-27T08:12:02Z

check-cla/action.yml

- core.setOutput('hasSigned', hasSigned);
-
- # add [cla-signed] label if actor has already signed
- - name: Add label


It's a common pattern for actions to include all JS inlined, even if it's not great, let's follow that for now

jezdez · 2023-04-27T08:12:31Z

check-cla/action.yml

+ # has_label, number, contributor, url, has_signed
+ - name: Collect PR metadata
 uses: actions/github-script@v6
- id: contributors
+ id: metadata
 with:
 github-token: ${{ inputs.token }}
 script: |
- console.log(context);
- const getContributors = async () => {
- try {
- const results = (
- await github.rest.repos.getContent({
- owner: 'conda',
- repo: 'infrastructure',
- path: '.clabot'
- })
- );
- return JSON.parse(Buffer.from(results.data.content, results.data.encoding).toString('utf-8')).contributors;
- } catch (err) {
- core.error(`Could not retrieve contributors, returning undefined. Reason: ${err}`)
- return undefined;
- }
- }
- const contributors = await getContributors();
- console.log(contributors);
- const pull_request = (context.payload.issue || context.payload.pull_request || context.payload);
- const creator = pull_request.user.login;
- console.log(creator);
- const hasSigned = contributors.includes(creator);
- console.log(hasSigned);
- core.setOutput('contributors', contributors);
- core.setOutput('hasSigned', hasSigned);
-
- # add [cla-signed] label if actor has already signed
- - name: Add label
+ 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}`);


Good changes!

jezdez · 2023-04-27T08:22:16Z

set-commit-status/action.yml

@@ -0,0 +1,51 @@
+---
+name: Set Commit Status
+description: Modifies the commit status of the most recent commit.


kenodegard · 2023-04-27T19:20:03Z

check-cla/action.yml

+ 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](https://conda.io/en/latest/contributing.html#conda-contributor-license-agreement). We then need to manually verify your signature, merge the PR (${{ steps.cla-pr.outputs.pull-request-url }}), and ping the bot to refresh the PR.
+ 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.


@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

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.

kenodegard self-assigned this Apr 3, 2023

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Apr 3, 2023

kenodegard changed the title ~~Update check-cla to customize which CLA repo to use~~ Update check-cla to customize which CLA repo to use Apr 3, 2023

kenodegard force-pushed the customize-cla-repo branch 3 times, most recently from 6facc7a to 12b993b Compare April 4, 2023 17:09

Update check-cla to customize which CLA repo

ee9d811

kenodegard force-pushed the customize-cla-repo branch from 12b993b to a21df6e Compare April 4, 2023 18:35

Adds set-commit-status action

ec9f0b4

kenodegard force-pushed the customize-cla-repo branch from a21df6e to ec9f0b4 Compare April 4, 2023 20:03

Update READMEs and descriptions

a3dded4

kenodegard force-pushed the customize-cla-repo branch from 38b19ad to a3dded4 Compare April 4, 2023 20:16

kenodegard added 4 commits April 4, 2023 15:27

Use JavaScript, not TypeScript

6c83ecc

Don't need to authenticate Octokit object

2b2d732

Remove redundant debug statements

5361102

Dumb JS split

528c212

kenodegard force-pushed the customize-cla-repo branch 7 times, most recently from eaaa6b1 to ba5634e Compare April 4, 2023 21:36

Flatten await and keep try-catch simple

83dab52

kenodegard force-pushed the customize-cla-repo branch from ba5634e to 83dab52 Compare April 4, 2023 21:37

Set author/committer and delete branch on merge

b3b9940

kenodegard force-pushed the customize-cla-repo branch 4 times, most recently from 1ff2e62 to 3769afa Compare April 4, 2023 22:51

kenodegard added 3 commits April 5, 2023 00:54

Fix inputs

4729d17

Fallback sha

b2db323

debugging comment payload

9bdcc51

kenodegard force-pushed the customize-cla-repo branch from 30261fa to 9bdcc51 Compare April 5, 2023 06:12

Remove temporary raw const

43ec963

kenodegard force-pushed the customize-cla-repo branch from 6121130 to 43ec963 Compare April 5, 2023 06:21

kenodegard added 4 commits April 5, 2023 11:52

Optional react to comment

d8454ec

Add token to reaction

8ee0ba0

Replace rocket with eyes

5ab5369

Reduce noise

ebb06e5

kenodegard commented Apr 5, 2023

View reviewed changes

kenodegard added 5 commits April 5, 2023 13:54

Include classic PAT instructions

a4ac617

GFM

4f67ffb

Extract PR number for sticky comment

d66d4eb

Support both PRs and "issues"

71c4f55

Extract metadata whether triggered as a PR or "issue" comment

6146699

kenodegard force-pushed the customize-cla-repo branch from a26a461 to 6146699 Compare April 5, 2023 20:10

kenodegard added 3 commits April 5, 2023 15:17

Group metadata steps

5616a98

Update comments and step names

3c9f741

Use correct url

ae8e19e

kenodegard commented Apr 5, 2023

View reviewed changes

travishathaway reviewed Apr 12, 2023

View reviewed changes

jezdez self-requested a review April 12, 2023 09:16

kenodegard mentioned this pull request Apr 24, 2023

The CLA instructions should say a human reviews each request conda/conda-docs#854

Closed

2 tasks

jezdez approved these changes Apr 27, 2023

View reviewed changes

kenodegard commented Apr 27, 2023

View reviewed changes

kenodegard merged commit b6821f2 into main Apr 27, 2023

kenodegard deleted the customize-cla-repo branch April 27, 2023 19:54

github-actions bot added the locked [bot] locked due to inactivity label Apr 27, 2024

github-actions bot locked as resolved and limited conversation to collaborators Apr 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update `check-cla` to customize which CLA repo to use #91

Update `check-cla` to customize which CLA repo to use #91

kenodegard commented Apr 3, 2023 •

edited

Loading

kenodegard Apr 5, 2023

kenodegard Apr 5, 2023

kenodegard Apr 5, 2023

jezdez Apr 27, 2023

travishathaway Apr 12, 2023

kenodegard Apr 12, 2023

jezdez Apr 27, 2023

jezdez Apr 27, 2023

jezdez Apr 27, 2023

jezdez Apr 27, 2023

kenodegard Apr 27, 2023 •

edited

Loading

kathatherine Apr 27, 2023

Update check-cla to customize which CLA repo to use #91

Update check-cla to customize which CLA repo to use #91

Conversation

kenodegard commented Apr 3, 2023 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kenodegard Apr 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Update `check-cla` to customize which CLA repo to use #91

Update `check-cla` to customize which CLA repo to use #91

kenodegard commented Apr 3, 2023 •

edited

Loading

kenodegard Apr 27, 2023 •

edited

Loading