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.

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

ci: Change workflow pr-check-links to review only the diffs #107

Merged
Merged
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
2 changes: 2 additions & 0 deletions .github/workflows/cron-check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ jobs:
--exclude-path ./themes/
--exclude-path ./layouts/
.
# Fail action on broken links
fail: true

- name: Suggestions
if: failure()
Expand Down
45 changes: 40 additions & 5 deletions .github/workflows/pr-check-links.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Check links
name: Check links in diffs

on:
pull_request:
Expand All @@ -8,10 +8,45 @@ jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Clone repository
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{github.event.pull_request.head.ref}}
repository: ${{github.event.pull_request.head.repo.full_name}}

- name: Check out main branch
run: git checkout main

- name: Dump all links from main
id: dump_links_from_main
uses: lycheeverse/lychee-action@v1
with:
args: |
--dump
--include-fragments
--exclude-path ./themes/
--exclude-path ./layouts/
.
output: ./links-main.txt

- name: Print links-main.txt in main
run: cat links-main.txt

- name: Stash untracked files
run: git stash push --include-untracked

- name: Check out feature branch
run: git checkout ${{ github.head_ref }}

- name: Apply stashed changes
# Apply stashed changes, ignore errors if stash is empty
run: git stash pop || true

- name: Append links-main.txt to .lycheeignore
run: cat links-main.txt >> .lycheeignore

- name: Link Checker
id: lychee
- name: Check links
uses: lycheeverse/lychee-action@v1
with:
args: |
Expand All @@ -26,7 +61,7 @@ jobs:
- name: Suggestions
if: failure()
run: |
echo -e "\nPlease review the links reported in Link Checker step above."
echo -e "\nPlease review the links reported in the Check links step above."
echo -e "If a link is valid but fails due to a CAPTCHA challenge, IP blocking, login requirements, etc.,
consider adding such links to .lycheeignore file to bypass future checks.\n"
exit 1