Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 22 additions & 24 deletions .github/workflows/links.yaml
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# Internal links are already checked by the Docusaurus build
# (onBrokenLinks: "throw" in docusaurus.config.ts), so this only
# needs to cover external URLs.
name: Link checker

on:
push:
branches:
- main
pull_request:
branches:
- main
schedule:
- cron: "17 6 * * 1" # weekly: external links rot without any commit
workflow_dispatch:

permissions:
contents: read

jobs:
build:
lychee:
name: Link checker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7

- name: Install pnpm
uses: pnpm/action-setup@v6
with:
# Pinned below 11.12.0, whose self-install crashes with
# "Cannot use 'in' operator to search for 'integrity' in undefined".
# https://github.com/pnpm/action-setup/issues/276
# https://github.com/pnpm/pnpm/issues/12959
version: 11.11.0


- uses: actions/setup-node@v7
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
node-version: 22
persist-credentials: false

- name: MDX Broken Link Checker
uses: KaiSpencer/gh-action-check-broken-links@v0
- name: Check links
uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2.9.0
with:
# Required: The base URL to check links against
# For example: /pages/foo.mdx will be checked against https://mysite.com/foo
baseUrl: 'https://nyu-its.github.io/rts-docs-dev/'

args: >-
--no-progress
'./docs/**/*.md' './docs/**/*.mdx'
'./blog/**/*.md' './blog/**/*.mdx'
# External links are flaky, so only the scheduled/manual runs fail;
# PRs report results in the job summary without blocking.
fail: ${{ github.event_name != 'pull_request' }}
jobSummary: true
2 changes: 2 additions & 0 deletions docs/hpc/01_getting_started/01_intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ If you are an active user, you can proceed to one of the categories on the left.

## Announcements
<iframe src="https://docs.google.com/presentation/d/e/2PACX-1vSG9zZs-t9SEUZTsHxzsSGO7Y_seexmJZpDYudAuOWSBvRf1HYN_RSEzqJolniKjWvm4AtgpeNKbVYx/pubembed?start=true&loop=true&delayms=5000" frameborder="0" width="960" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>

[lychee test link](https://lychee-test.invalid/this-page-does-not-exist)
Loading