Skip to content

Commit

Permalink
feat: check markdown links
Browse files Browse the repository at this point in the history
  • Loading branch information
vscaiceanu-1a committed Oct 25, 2023
1 parent 2075b38 commit 41e4d7b
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 3 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/check-md.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Check Markdown links

on:
pull_request:
branches:
- main
- 'release/*'

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/workflows/markdown.links.config.json'
check-modified-files-only: 'no' # TODO: set to 'yes' before merging
use-verbose-mode: 'yes'
use-quiet-mode: 'yes'
7 changes: 7 additions & 0 deletions .github/workflows/markdown.links.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"ignorePatterns": [
{
"pattern": "^https://dummy-website.com"
}
]
}
2 changes: 1 addition & 1 deletion tools/github-actions/download-build-output/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Download and restore the `dist` folders from GitHub artifact (check [Upload build output](../upload-build-output/readme.md))

## Task options
See [Action specifications](tools/github-actions/download-build-output/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example
```yaml
Expand Down
2 changes: 1 addition & 1 deletion tools/github-actions/setup/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Including :

## Task options

See [Action specifications](tools/github-actions/setup/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example

Expand Down
2 changes: 1 addition & 1 deletion tools/github-actions/upload-build-output/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can then use the download build output action for the download (check [Downl

## Task options

See [Action specifications](tools/github-actions/upload-build-output/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example

Expand Down

0 comments on commit 41e4d7b

Please sign in to comment.