Skip to content

Conversation

@joshuafernandes
Copy link
Contributor

@joshuafernandes joshuafernandes commented Nov 6, 2025

Note

Switches the docs link check to run linkspector via npm with Node setup and adds a Chrome sandbox workaround for Ubuntu 24.04.

  • CI: docs-link-check/action.yml
    • Read Node version from .nvmrc and set up Node via actions/setup-node@v6.
    • Add Ubuntu 24.04 Chrome sandbox workaround.
    • Install and run @umbrelladocs/linkspector CLI (linkspector check -c ${{ inputs.CONFIG_FILE }}) instead of the action.
  • Docs
    • Update README.md with a TODO to add lint checks.

Written by Cursor Bugbot for commit b1e2bba. This will update automatically on new commits. Configure here.

shell: bash
run: |
npm install -g @umbrelladocs/linkspector
echo 'linkspector version: $(linkspector --version)'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Shell command substitution blocked by quoting.

The echo statement uses single quotes around the command substitution, which prevents the shell from executing the command. It will print the literal string "linkspector version: $(linkspector --version)" instead of showing the actual version. Should use double quotes or no quotes to allow command substitution.

Fix in Cursor Fix in Web

Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

run: |
set -eo pipefail
echo "🔍 Checking for broken links..."
linkspector check -c ${{ inputs.CONFIG_FILE }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this still allow optionally configuring the FAIL_LEVEL and FILTER_MODE for the linkspector action?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can put that in when I add in the build checks so it is similar to the last one - from memory that was for reviewdog but I'll dig into the levels to keep it compatible

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right it looks like it is for reviewdog (https://github.com/UmbrellaDocs/action-linkspector?tab=readme-ov-file#action-inputs). Without those settings, I wonder how this action will behave specifically for the filter mode (flagging errors for all changed files, added files only, etc.)

@joshuafernandes joshuafernandes merged commit d48cb5c into main Nov 7, 2025
1 check passed
@joshuafernandes joshuafernandes deleted the umbrella branch November 7, 2025 00:21
joshuafernandes added a commit that referenced this pull request Nov 7, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
joshuafernandes added a commit that referenced this pull request Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants