Skip to content

Commit

Permalink
Add *.rst glob pattern to defaults (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeldycke authored Jun 11, 2023
1 parent 21b2b78 commit 0c01f23
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Link Checker
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'
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
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Expand Down
10 changes: 9 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,22 @@ jobs:
--no-progress
'./**/*.md'
'./**/*.html'
'./**/*.rst'
fail: true
- name: test workflow inputs
- name: test workflow inputs - Markdown
uses: ./
with:
args: -v fixtures/TEST.md
format: json
output: /tmp/foo.json
fail: true
- name: test workflow inputs - rST
uses: ./
with:
args: -v fixtures/TEST.rst
format: json
output: /tmp/foo.json
fail: true
- name: directory
uses: ./
with:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test_cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
--no-progress
'./**/*.md'
'./**/*.html'
'./**/*.rst'
# Fail the action on broken links.
# If the pipeline fails, the cache will _not_ be stored
fail: true
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ See [action.yml](./action.yml) for a full list of supported arguments and their
uses: lycheeverse/[email protected]
with:
# Check all markdown and html files in repo (default)
args: --verbose --no-progress './**/*.md' './**/*.html'
args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'
# Use json as output format (instead of markdown)
format: json
# Use different output file path
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: "Quickly check links in Markdown, HTML, and text files"
inputs:
args:
description: "Lychee arguments (https://github.com/lycheeverse/lychee#commandline-parameters)"
default: "--verbose --no-progress './**/*.md' './**/*.html'"
default: "--verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'"
required: false
debug:
description: "Enable debug output in action (set -x). Helpful for troubleshooting."
Expand Down
29 changes: 29 additions & 0 deletions fixtures/TEST.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. figure:: awesome.png
:alt: Logo

Logo

.. figure:: #awesome
:alt: Anchors should be ignored

Anchors should be ignored

Normal link, which should work as expected.
`Wikipedia <https://en.wikipedia.org/wiki/Static_program_analysis>`__

Just a normal link without any markup around it should work, too.
https://endler.dev

Test GZIP compression. (See
https://github.com/analysis-tools-dev/static-analysis/issues/350)
`LDRA <https://ldra.com>`__

Some more complex formatting to test that Markdown parsing works. |CC0|

Test HTTP and HTTPS for the same site. http://spinroot.com/cobra/
https://spinroot.com/cobra/

[email protected]

.. |CC0| image:: https://i.creativecommons.org/p/zero/1.0/88x31.png
:target: https://creativecommons.org/publicdomain/zero/1.0/

0 comments on commit 0c01f23

Please sign in to comment.