add documentation on using the param when testing local files (as in… #61
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: | |
| - repository_dispatch | |
| - workflow_dispatch | |
| - push | |
| - pull_request | |
| jobs: | |
| lychee-action: | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| name: Test the lychee link checker action | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: test defaults | |
| uses: ./ | |
| with: | |
| fail: true | |
| - name: test explicit lychee version | |
| uses: ./ | |
| with: | |
| lycheeVersion: 0.9.0 | |
| - name: test globs | |
| uses: ./ | |
| with: | |
| args: >- | |
| --exclude-mail | |
| --verbose | |
| --no-progress | |
| './**/*.md' | |
| './**/*.html' | |
| './**/*.rst' | |
| fail: true | |
| - name: test --base argument | |
| uses: ./ | |
| with: | |
| args: >- | |
| --base . | |
| --verbose | |
| --no-progress | |
| './**/*.md' | |
| './**/*.html' | |
| './**/*.rst' | |
| fail: true | |
| - name: Install jq | |
| run: sudo apt-get install jq | |
| - name: test workflow inputs - Markdown | |
| uses: ./ | |
| with: | |
| args: -v fixtures/TEST.md | |
| format: json | |
| output: ${{ github.workspace }}/foo_md.json | |
| fail: true | |
| - name: Validate JSON - Markdown | |
| run: | | |
| if ! jq empty ${{ github.workspace }}/foo_md.json; then | |
| echo "Output file does not exist or is not valid JSON" | |
| exit 1 | |
| fi | |
| - name: test workflow inputs - rST | |
| uses: ./ | |
| with: | |
| args: -v fixtures/TEST.rst | |
| format: json | |
| output: ${{ github.workspace }}/foo_rst.json | |
| fail: true | |
| - name: Validate JSON - rST | |
| run: | | |
| if ! jq empty ${{ github.workspace }}/foo_rst.json; then | |
| echo "Output file does not exist or is not valid JSON" | |
| exit 1 | |
| fi | |
| - name: directory | |
| uses: ./ | |
| with: | |
| args: --exclude-mail . | |
| fail: true | |
| - name: test format override | |
| uses: ./ | |
| with: | |
| args: --format markdown -v fixtures/TEST.md | |
| format: doesnotexist # gets ignored if format set in args | |
| output: ${{ github.workspace }}/foo.txt | |
| fail: true | |
| - name: test debug | |
| uses: ./ | |
| with: | |
| debug: true | |
| - name: test custom GitHub token | |
| uses: ./ | |
| with: | |
| token: ${{ secrets.CUSTOM_TOKEN }} |