Skip to content

chore: Add link check action#66

Closed
lbeckman314 wants to merge 83 commits intomainfrom
fix/link-check
Closed

chore: Add link check action#66
lbeckman314 wants to merge 83 commits intomainfrom
fix/link-check

Conversation

@lbeckman314
Copy link
Contributor

Overview ⚙️

Add automatic link checking action (and minor updates to header CSS + copyright footer)

bwalsh and others added 30 commits September 23, 2025 12:16
Copilot AI review requested due to automatic review settings February 9, 2026 17:54
@lbeckman314 lbeckman314 self-assigned this Feb 9, 2026
@netlify
Copy link

netlify bot commented Feb 9, 2026

Deploy Preview for calypr ready!

Name Link
🔨 Latest commit 28f4037
🔍 Latest deploy log https://app.netlify.com/projects/calypr/deploys/698a1f6e432c7800089d02d1
😎 Deploy Preview https://deploy-preview-66--calypr.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lbeckman314 lbeckman314 added bug Something isn't working enhancement New feature or request labels Feb 9, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds automated link checking via a GitHub Action, along with small MkDocs presentation tweaks (header stacking and footer copyright display).

Changes:

  • Add a new GitHub Actions workflow to run Lychee link checking on a schedule and on pushes.
  • Update MkDocs footer copyright configuration.
  • Adjust header z-index via custom CSS.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
mkdocs.yml Adds a footer copyright string (currently using inline JS).
docs/stylesheets/extra.css Raises .md-header stacking order via z-index.
.github/workflows/link-check.yml Introduces a Lychee-based link check workflow + scheduled issue creation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

**/_*.md
# Navigation is handled by .nav.yaml files in the docs/ directory via awesome-nav plugin.

copyright: Copyright &copy; <script>document.write(new Date().getFullYear())</script> CALYPR
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

Inline <script> in the MkDocs config footer introduces executable JavaScript into every page. This can be blocked by CSP in some hosting setups and increases security risk compared to a build-time year. Prefer generating the year at build time via a theme template override (e.g., in an overrides/footer template using build_date_utc.year) or keep this as static text updated as needed.

Suggested change
copyright: Copyright &copy; <script>document.write(new Date().getFullYear())</script> CALYPR
copyright: "Copyright © 2026 CALYPR"

Copilot uses AI. Check for mistakes.
Comment on lines +6 to +9
on:
push:
workflow_dispatch:
schedule:
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

The workflow header says it runs on pull requests, but the triggers only include push/workflow_dispatch/schedule. Add a pull_request trigger (optionally restricted to relevant paths) or update the comment to match the actual behavior.

Copilot uses AI. Check for mistakes.
push:
workflow_dispatch:
schedule:
# Run weekly on Sunday at 0 AM UTC to catch external link changes
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

The schedule comment says “Sunday at 0 AM UTC”, but the cron expression (0 9 * * 0) runs at 09:00 UTC. Update either the comment or the cron value so they match.

Suggested change
# Run weekly on Sunday at 0 AM UTC to catch external link changes
# Run weekly on Sunday at 09:00 UTC to catch external link changes

Copilot uses AI. Check for mistakes.
Comment on lines +15 to +20
pull-requests: write
issues: write

jobs:
lychee:
runs-on: ubuntu-latest
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

Workflow permissions are broader than necessary: nothing in this workflow currently uses pull-requests: write, and issues: write is only needed for the scheduled run that creates an issue. Consider removing pull-requests: write and scoping issues: write to only the job/step that needs it (or guarding via a separate job) to follow least-privilege.

Suggested change
pull-requests: write
issues: write
jobs:
lychee:
runs-on: ubuntu-latest
jobs:
lychee:
runs-on: ubuntu-latest
permissions:
contents: read
issues: write

Copilot uses AI. Check for mistakes.
Comment on lines +29 to +30
# Check all markdown files in docs/ and README.md
args: --verbose --no-progress --exclude-private 'docs/**/*.md' 'README.md' '**/*.md'
Copy link

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

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

The args/comment don’t match: the comment says only docs/ and README.md, but the args include '**/*.md' which already covers those and will also scan every Markdown file in the repo. Either drop the redundant globs or update the comment (and consider restricting to the intended paths to reduce runtime/noise).

Suggested change
# Check all markdown files in docs/ and README.md
args: --verbose --no-progress --exclude-private 'docs/**/*.md' 'README.md' '**/*.md'
# Check all Markdown files in the repository
args: --verbose --no-progress --exclude-private '**/*.md'

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

Comments