Skip to content

More link check improvements #2010

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

Merged
merged 1 commit into from
Jul 12, 2025
Merged

More link check improvements #2010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 0 additions & 7 deletions .github/scripts/.lychee-relative.toml
View file
Open in desktop

This file was deleted.

0 .github/scripts/dependencies.dockerfile → .github/scripts/dependencies.Dockerfile
View file
Open in desktop
File renamed without changes.
32 changes: 15 additions & 17 deletions .github/scripts/link-check.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ export MSYS_NO_PATHCONV=1 # for Git Bash on Windows

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
ROOT_DIR="$SCRIPT_DIR/../.."
DEPENDENCIES_DOCKERFILE="$SCRIPT_DIR/dependencies.dockerfile"
DEPENDENCIES_DOCKERFILE="$SCRIPT_DIR/dependencies.Dockerfile"

# Parse command line arguments
RELATIVE_ONLY=false
MODIFIED_FILES=""
LOCAL_LINKS_ONLY=false
TARGET=""

while [[ $# -gt 0 ]]; do
case $1 in
--relative-only)
RELATIVE_ONLY=true
--local-links-only)
LOCAL_LINKS_ONLY=true
shift
;;
*)
# Treat any other arguments as file paths
MODIFIED_FILES="$MODIFIED_FILES $1"
TARGET="$TARGET $1"
shift
;;
esac
Expand All @@ -29,26 +29,24 @@ done
# Extract lychee version from dependencies.dockerfile
LYCHEE_VERSION=$(grep "FROM lycheeverse/lychee:" "$DEPENDENCIES_DOCKERFILE" | sed 's/.*FROM lycheeverse\/lychee:\([^ ]*\).*/\1/')

# Determine target files/directories and config file
TARGET="."
LYCHEE_CONFIG=".github/scripts/.lychee.toml"

if [[ "$RELATIVE_ONLY" == "true" ]]; then
LYCHEE_CONFIG=".github/scripts/.lychee-relative.toml"
fi

if [[ -n "$MODIFIED_FILES" ]]; then
TARGET="$MODIFIED_FILES"
if [[ -z "$TARGET" ]]; then
TARGET="."
fi

# Build the lychee command with optional GitHub token
CMD="lycheeverse/lychee:$LYCHEE_VERSION --verbose --config $LYCHEE_CONFIG"
CMD="lycheeverse/lychee:$LYCHEE_VERSION --verbose --root-dir /data"

# Add GitHub token if available
if [[ -n "$GITHUB_TOKEN" ]]; then
CMD="$CMD --github-token $GITHUB_TOKEN"
fi

if [[ "$LOCAL_LINKS_ONLY" == "true" ]]; then
CMD="$CMD --scheme file --include-fragments"
else
CMD="$CMD --config .github/scripts/lychee-config.toml"
fi

CMD="$CMD $TARGET"

# Determine if we should allocate a TTY
Expand Down
0 .github/scripts/.lychee.toml → .github/scripts/lychee-config.toml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/reusable-link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
if: github.event_name == 'pull_request'
env:
GITHUB_TOKEN: ${{ github.token }}
run: ./.github/scripts/link-check.sh --relative-only
run: ./.github/scripts/link-check.sh --local-links-only

- name: Get modified files
if: github.event_name == 'pull_request'
Expand Down
Loading