Update link-check to 0.12 using CLI and comment reporting #3700

rogermparent · 2022-06-28T19:05:59Z

This PR upgrades link-check to 0.12, which should squash the "diffs are too big" problem/bug.

In order to squash an issue where node:buffer couldn't be imported in the GH Action, this PR now just uses link check through the CLI and its stdout to make a special review comment which gets edited after each check.

#3700 (comment)

We no longer have three checks for link check!

rogermparent · 2022-06-28T20:52:32Z

.github/workflows/link-check-deploy.yml

@@ -12,9 +12,10 @@ jobs:
      github.event.deployment.ref != 'main' &&
      github.event.deployment_status.state == 'success'
    steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3


I'll follow up with a change to update actions/checkout in all our other actions as well, from what I've seen it's a no-downsides performance upgrade.

shcheklein · 2022-07-12T00:55:30Z

@rogermparent ping

rogermparent · 2022-07-13T16:52:42Z

Sorry, this has fallen by the wayside a bit, I'll bump it up in my priorities this week!

github-actions · 2022-07-19T02:35:28Z

Link Check Report

There were no links to check!

rogermparent · 2022-07-19T03:03:14Z

.github/workflows/link-check-deploy.yml

    runs-on: ubuntu-latest
+    continue-on-error: true


Lets us continue even if an existing report comment isn't found

Could this also skip any other error occurrence without reporting the error?

It seems like it does, I'll need to improve that next. If an error occurs, the script will just write the "Link Check Report" h1 with no content. I'm pretty sure that can be fixed by getting stderr output into the content body in the bash script part of the action.

rogermparent · 2022-07-19T03:04:50Z

.github/workflows/link-check-deploy.yml

+          set +e
+          body="<h1 id=\"link-check\">Link Check Report</h1>
+
+          $(
+            npx repo-link-check \
+            -d -c config/link-check/config.yml \
+            -r ${{ github.event.deployment.payload.web_url }}
+          )"


set +e prevents the script from exiting when repo-link-check exits with code 2. +e is a normal default for interactive terminals, but -e is used in some CI like GitHub Actions.

rogermparent · 2022-07-19T03:06:18Z

.github/workflows/link-check-deploy.yml

+          body="${body//'%'/'%25'}"
+          body="${body//$'\n'/'%0A'}"
+          body="${body//$'\r'/'%0D'}"
+          echo "::set-output name=report::$body"
+          exit 0


From create-or-update-comment docs, escapes the command result for GH Action output

rogermparent · 2022-07-19T03:07:24Z

.github/workflows/link-check-deploy.yml

+      - name: Find PR associated with deployment
+        uses: actions/github-script@v6
+        id: pr-number
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
-          diff: main
-          configFile: config/link-check/config.yml
-          rootURL: '${{ github.event.deployment.payload.web_url }}'
-          output: checksAction
-      - uses: LouisBrunner/[email protected]
-        if: ${{ success() }}
+          script: |
+            const findPR = require('./.github/workflows/deployment-report.js')
+            return await findPR({ github, context, core })


This action is really handy for rapidly prototyping weird stuff with the GitHub API. You can import modules so most of the code can be properly linted instead of being stuck in a YAML block.

rogermparent · 2022-07-19T03:08:38Z

.github/workflows/link-check-deploy.yml

+      - name: Find Existing Link Check Report Comment
+        uses: peter-evans/find-comment@v2
+        id: fc
        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          check_id: ${{ steps.build_check.outputs.check_id }}
-          status: completed
-          conclusion: ${{ steps.check.outputs.conclusion }}
-          output: ${{ steps.check.outputs.output }}
-      - uses: LouisBrunner/[email protected]
-        if: ${{ failure() }}
+          issue-number: ${{ steps.pr-number.outputs.result }}
+          comment-author: 'github-actions[bot]'
+          body-includes: "<h1 id=\"link-check\">Link Check Report</h1>"


Adds a way to navigate to the report comment with the anchor #user-content-link-check, and also helps further prevent false positives on which comment we find to edit.

rogermparent · 2022-07-19T03:12:12Z

.github/workflows/deployment-report.js

+module.exports = async ({ github, context }) => {
+  const sha = context.sha
+  const owner = context.payload.repository.owner.login
+  const repo = context.payload.repository.name
+  const { data: pulls } = await github.rest.pulls.list({
+    state: 'open',
+    owner,
+    repo
+  })
+  const actionPull = pulls.find(pull => pull.head.sha === sha)
+  return actionPull.number
+}


The deployment_status event we use from Heroku doesn't actually include info about the pull request, so we have to duck into the GitHub API to get that PR via the current commit's sha.

yathomasi

Looking alright to me. Great work @rogermparent.
I can see the report generated and updated fine.

shcheklein

Roger, have you tried to use CML for this? Could you share your experience?

rogermparent · 2022-07-19T19:32:35Z

I took a look at CML, but hit the "Known Issues" portion of the send-comment docs that states the following:

commit_id has been locked.

This error is caused by using the default GitHub token with cml send-comment --update. Use a personal access token (PAT) instead.

Beyond that, I'm not sure how well it handles how we're using deployment_status, but maybe that's not an issue.

It seemed as if CML may not be capable of the few niche requirements of this action, so I just finished the last parts of the implementation I already had mostly done to take the path of least resistance for getting this update in. I'd be happy to make a follow-up PR trying out CML, and then report back on the experience.

Update link-check to 0.12 in both CLI and GHA

aa04356

shcheklein temporarily deployed to dvc-org-link-check-0-12-0qb8is June 28, 2022 19:06 Inactive

rogermparent self-assigned this Jun 28, 2022

Update checkout action and add setup-node

9b29010

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is June 28, 2022 20:45 Inactive

Merge branch 'main' of github.com:iterative/dvc.org into link-check-0.12

427a7da

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is June 28, 2022 20:48 Inactive

rogermparent commented Jun 28, 2022

View reviewed changes

Specify node version and cache

8187afa

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is June 28, 2022 21:15 Inactive

Use CLI link check

15f7829

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 17:17 Inactive

Rename action and take it off deployment event

ad25b27

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 17:30 Inactive

Fix malformed run item

758ca30

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 17:41 Inactive

Use expanded script with npx

9bb0c32

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 18:16 Inactive

Try using comment report

04c75c7

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 18:32 Inactive

Fix use of build log

c82b71d

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 19:11 Inactive

More GHA config tweaks

1230510

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 13, 2022 20:02 Inactive

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 14, 2022 01:56 Inactive

rogermparent force-pushed the link-check-0.12 branch from 86f3938 to 06ee952 Compare July 14, 2022 02:02

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 14, 2022 02:03 Inactive

rogermparent force-pushed the link-check-0.12 branch from 06ee952 to 7af895a Compare July 14, 2022 02:11

Add test links

d79a584

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 01:29 Inactive

Add continue-on-error to link check action steps

d74bbfc

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 01:42 Inactive

Adjust formatting, add exit 0

bec3890

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 02:05 Inactive

set +e

7063ec1

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 02:14 Inactive

Use HTML element

2412d89

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 02:30 Inactive

revert broken links

61be693

rogermparent temporarily deployed to dvc-org-link-check-0-12-0qb8is July 19, 2022 02:46 Inactive

rogermparent commented Jul 19, 2022

View reviewed changes

rogermparent marked this pull request as ready for review July 19, 2022 03:13

rogermparent requested a review from a team July 19, 2022 03:13

yathomasi approved these changes Jul 19, 2022

View reviewed changes

rogermparent merged commit cf1447b into main Jul 19, 2022

rogermparent deleted the link-check-0.12 branch July 19, 2022 13:50

This was referenced Jul 19, 2022

Use link check from the CLI instead of an action #3625

Closed

Remove out-of-date comment on link check deploy workflow #3782

Merged

shcheklein reviewed Jul 19, 2022

View reviewed changes

This was referenced Jul 20, 2022

Upgrade link-check to 0.12 iterative/cml.dev#271

Merged

Upgrade link check to 0.12 iterative/mlem.ai#139

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update link-check to 0.12 using CLI and comment reporting #3700

Update link-check to 0.12 using CLI and comment reporting #3700

rogermparent commented Jun 28, 2022 •

edited

Loading

rogermparent Jun 28, 2022

shcheklein commented Jul 12, 2022

rogermparent commented Jul 13, 2022

github-actions bot commented Jul 19, 2022 •

edited

Loading

rogermparent Jul 19, 2022

yathomasi Jul 19, 2022

rogermparent Jul 20, 2022

rogermparent Jul 19, 2022

rogermparent Jul 19, 2022

rogermparent Jul 19, 2022

rogermparent Jul 19, 2022 •

edited

Loading

rogermparent Jul 19, 2022

yathomasi left a comment

shcheklein left a comment

rogermparent commented Jul 19, 2022 •

edited

Loading

Update link-check to 0.12 using CLI and comment reporting #3700

Update link-check to 0.12 using CLI and comment reporting #3700

Conversation

rogermparent commented Jun 28, 2022 • edited Loading

Choose a reason for hiding this comment

shcheklein commented Jul 12, 2022

rogermparent commented Jul 13, 2022

github-actions bot commented Jul 19, 2022 • edited Loading

Link Check Report

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

rogermparent Jul 19, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yathomasi left a comment

Choose a reason for hiding this comment

shcheklein left a comment

Choose a reason for hiding this comment

rogermparent commented Jul 19, 2022 • edited Loading

rogermparent commented Jun 28, 2022 •

edited

Loading

github-actions bot commented Jul 19, 2022 •

edited

Loading

rogermparent Jul 19, 2022 •

edited

Loading

rogermparent commented Jul 19, 2022 •

edited

Loading