mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-03 03:35:02 -05:00
Compare commits
2 Commits
link-check
...
test-link-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dbcb3cc656 | ||
|
|
75ab3d98d1 |
24
.github/workflows/link_checker_workflow.yaml
vendored
24
.github/workflows/link_checker_workflow.yaml
vendored
@@ -32,7 +32,9 @@ jobs:
|
|||||||
restore-keys: cache-lychee-
|
restore-keys: cache-lychee-
|
||||||
|
|
||||||
- name: Link Checker
|
- name: Link Checker
|
||||||
|
id: lychee-check # Give it an ID to reference later
|
||||||
uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
|
uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
|
||||||
|
continue-on-error: true # Let the workflow continue so we can handle the summary order
|
||||||
with:
|
with:
|
||||||
args: >
|
args: >
|
||||||
--quiet
|
--quiet
|
||||||
@@ -42,20 +44,28 @@ jobs:
|
|||||||
--exclude '^neo4j\+.*' --exclude '^bolt://.*'
|
--exclude '^neo4j\+.*' --exclude '^bolt://.*'
|
||||||
README.md
|
README.md
|
||||||
docs/
|
docs/
|
||||||
output: /tmp/foo.txt
|
output: lychee-report.md
|
||||||
fail: true
|
format: markdown
|
||||||
jobSummary: true
|
fail: true # Mark the step outcome as 'failure' internally
|
||||||
|
jobSummary: false # IMPORTANT: Don't write the report yet!
|
||||||
debug: false
|
debug: false
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
# This step only runs if the 'lychee_check' step fails, ensuring the
|
|
||||||
# context note only appears when the developer needs to troubleshoot.
|
- name: Display Failure Report
|
||||||
- name: Display Link Context Note on Failure
|
# Run this ONLY if the link checker failed
|
||||||
if: ${{ failure() }}
|
if: steps.lychee-check.outcome == 'failure'
|
||||||
run: |
|
run: |
|
||||||
|
# 1. Write YOUR Note First (Top of Summary)
|
||||||
echo "## Link Resolution Note" >> $GITHUB_STEP_SUMMARY
|
echo "## Link Resolution Note" >> $GITHUB_STEP_SUMMARY
|
||||||
echo "Local links and directory changes work differently on GitHub than on the docsite." >> $GITHUB_STEP_SUMMARY
|
echo "Local links and directory changes work differently on GitHub than on the docsite." >> $GITHUB_STEP_SUMMARY
|
||||||
echo "You must ensure fixes pass the **GitHub check** and also work with **\`hugo server\`**." >> $GITHUB_STEP_SUMMARY
|
echo "You must ensure fixes pass the **GitHub check** and also work with **\`hugo server\`**." >> $GITHUB_STEP_SUMMARY
|
||||||
echo "See [Link Checking and Fixing with Lychee](https://github.com/googleapis/genai-toolbox/blob/main/DEVELOPER.md#link-checking-and-fixing-with-lychee) for more details." >> $GITHUB_STEP_SUMMARY
|
echo "See [Link Checking and Fixing with Lychee](https://github.com/googleapis/genai-toolbox/blob/main/DEVELOPER.md#link-checking-and-fixing-with-lychee) for more details." >> $GITHUB_STEP_SUMMARY
|
||||||
echo "---" >> $GITHUB_STEP_SUMMARY
|
echo "---" >> $GITHUB_STEP_SUMMARY
|
||||||
|
|
||||||
|
# 2. Append the Actual Error Report (Below Note)
|
||||||
|
echo "### Broken Links Found" >> $GITHUB_STEP_SUMMARY
|
||||||
|
cat ./lychee-report.md >> $GITHUB_STEP_SUMMARY
|
||||||
|
|
||||||
|
# 3. Manually Fail the Job (Since we used continue-on-error above)
|
||||||
|
exit 1
|
||||||
|
|||||||
Reference in New Issue
Block a user