Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce link checks per PR #278

Merged
merged 8 commits into from
Apr 3, 2025
Merged

Enforce link checks per PR #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f9de2c4
tests: run broken link checks per pr
kollegian Mar 27, 2025
8cbe34a
update workflow to run per pr
kollegian Apr 3, 2025
cd1596e
add build
kollegian Apr 3, 2025
9ffd251
add localhost for pr checks
kollegian Apr 3, 2025
16d0a7b
unify workflows in one step
kollegian Apr 3, 2025
b167a06
continue if errored
kollegian Apr 3, 2025
f1ca044
Merge branch 'main' into checks/enforce-links-check
kollegian Apr 3, 2025
43b31c2
reformat
kollegian Apr 3, 2025
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
15 changes: 14 additions & 1 deletion .github/workflows/link_checker.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Link checker

on:
pull_request:
workflow_dispatch:
schedule:
- cron: '0 12 * * *'
Expand All @@ -27,8 +28,20 @@ jobs:

- name: Run crawler
id: crawler
run: yarn tsx scripts/checkLinks.ts
continue-on-error: true
run: |
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
echo "Running PR workflow: Building and starting local server..."
yarn build
sleep 5
yarn start &
sleep 15
export BASE_URL="http://localhost:3000"
else
export BASE_URL="https://www.docs.sei.io/"
fi
echo "Running link checker for ${BASE_URL}"
yarn tsx scripts/checkLinks.ts

- name: Upload broken links artifact
if: steps.crawler.outcome == 'failure'
Expand Down
7 changes: 3 additions & 4 deletions scripts/checkLinks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ const visitedLinks = new Set<string>();

async function main() {
const browserInstance = await chromium.launch();
const baseUrl = 'https://www.docs.sei.io/';
const baseUrl = process.env.BASE_URL || 'https://www.docs.sei.io/';
await crawlPages(baseUrl, browserInstance, 'main');

fs.writeFileSync('brokenLinks.json', JSON.stringify([...brokenLinks], null, 2));

if (brokenLinks.size > 0) {
Expand All @@ -31,7 +30,7 @@ async function crawlPages(url: string, browser: Browser, path: string) {
}

function isInternal(url: string) {
return url.includes('docs.sei');
return url.includes('docs.sei') || url.includes('localhost:3000');
}

async function checkInternalLinks(url: string, page: Page, path: string, browser: Browser) {
Expand All @@ -58,7 +57,7 @@ async function checkExternalLinks(url: string, page: Page, path: string, browser

async function isLinkBroken(page: Page, url: string, path: string) {
if (visitedLinks.has(url)) return false;
if (url.includes('localhost') || url.includes('.tar.gz')) return false;
if ((url.includes('localhost') && !url.includes(':3000')) || url.includes('.tar.gz')) return false;

let pageResponse: Response;
try {
Expand Down
Loading