Update README.md to include continue-on-error: true in action

[psobolewskiPhD]

I had to add

continue-on-error: true

in order for the next step to fire when there were broken links -- regardless of the if:
I tested with adding a Debug echo step after the lychee step.

- name: Debug Exit Code
        run: | 
          echo "Lychee exit code: ${{ steps.lychee.outputs.exit_code }}"

And this was skipped.

[mre]

Yeah, I think that makes sense. @YDX-2147483647, right?

[YDX-2147483647]

I agree that the example in the README does not work, but I suggest adding fail: false instead.

lychee-action/.github/workflows/links.yml

Lines 17 to 22 in 5cd5ba7

	- name: Link Checker
	id: lychee
	uses: ./ # Uses an action in the root directory
	with:
	args: --user-agent "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0" --verbose --exclude spinroot.com --no-progress './**/*.md' './**/*.html' './**/*.rst'
	fail: true

    - name: Link Checker
      id: lychee
      uses: lycheeverse/lychee-action@v2
+     with:
+         fail: false

If lychee is properly configured, fail: false and continue-on-error: true behave identically. But if lychee somehow cannot find any link, then fail: false fails the CI (due to failIfEmpty), but continue-on-error: true creates an issue with zero broken links.

---

I actually use fail: ${{ github.event_name == 'pull_request' }}. It fails on pull request, but create an issue otherwise (e.g., in main).

[mre]

Suggested change

	continue-on-error: true
	with:
	fail: false