-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit introduces an action based on the markdown check in release process for: https://github.com/eclipse-kuksa/kuksa-databroker/wiki/Release-Process#checking-links Intention is to run it on each PR, a PR in Databroker will be created as soon as this one is merged and tagged as v 4.1
- Loading branch information
Showing
5 changed files
with
39 additions
and
3 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Check Markdown | ||
|
||
An action using [markdown-link-check](https://github.com/tcort/markdown-link-check) to check that all links | ||
in markdown (`*.md`) files are functional. | ||
|
||
## How to use | ||
|
||
An example on how to use this action to check all `*.md` files in a repository is shown below. | ||
|
||
```yaml | ||
check-doc-links: | ||
name: Check links in markdown | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: eclipse-kuksa/kuksa-actions/check-markdown@4 | ||
|
||
``` | ||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
|
||
name: Checking Markdown | ||
description: Check if links in markdown files are functional | ||
|
||
runs: | ||
using: "composite" | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Install and run npm | ||
shell: bash | ||
run: | | ||
npm install -g markdown-link-check | ||
markdown-link-check --version | ||
find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check -q -a 403,200,404 |
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