GenevieveBuckley / broken-link-checker

Checking for broken links with lychee
MIT License
1 stars 0 forks source link

Remove broken link from README #22

Closed GenevieveBuckley closed 2 years ago

GenevieveBuckley commented 2 years ago

I want to see whether the lychee report opens an issue if all the links are good, or only if problems are found.

GenevieveBuckley commented 2 years ago

Answer: no, an automated issue is only created if broken links are found (or some other error takes place). This is good, that's what we want.

Here's the github actions logs from a successful run, where no broken links were found (and so, no issue needed to be made): Link checker

Run lycheeverse/lychee-action@v1.0.9
/usr/bin/docker run --name f88420bd6e213f09144944b470666de4925926_ff802b --label f88420 --workdir /github/workspace --rm -e GITHUB_TOKEN -e INPUT_ARGS -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_RETENTION_DAYS -e GITHUB_RUN_ATTEMPT -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e GITHUB_ACTION_REPOSITORY -e GITHUB_ACTION_REF -e GITHUB_PATH -e GITHUB_ENV -e RUNNER_OS -e RUNNER_NAME -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/broken-link-checker/broken-link-checker":"/github/workspace" f88420:bd6e213f09144944b470666de4925926 --verbose --no-progress **/*.md **/*.html --base-url https://napari.org --user-agent "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:93.0) Gecko/20100101 Firefox/93.0"
+ LYCHEE_OUT=lychee/out.md
+ LYCHEE_TMP=/tmp/lychee/out.md
+ GITHUB_WORKFLOW_URL='https://github.com/GenevieveBuckley/broken-link-checker/actions/runs/1383163926?check_suite_focus=true'
++ dirname /tmp/lychee/out.md
+ mkdir -p /tmp/lychee
+ lychee --output /tmp/lychee/out.md --verbose --no-progress '**/*.md' '**/*.html' --base-url https://napari.org --user-agent 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:93.0) Gecko/20100101 Firefox/93.0'
✔ https://www.wikipedia.org/ [200 OK]
+ exit_code=0
✔ https://forum.image.sc/ [200 OK]
+ '[' 0 -ne 0 ']'
📝 Summary
+ cat /tmp/lychee/out.md
---------------------
+ echo
🔍 Total............2
+ echo ::set-output name=exit_code::0
✅ Successful.......2
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
🚫 Errors...........0

Create issue from file

Run peter-evans/create-issue-from-file@v3
File not found at path './lychee/out.md'

:tada: