Skip to content

Commit

Permalink
Enable Markdown Link Check (#834)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmitoraj authored Sep 8, 2023
1 parent 2f1ba38 commit 570ba35
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/daily-markdown-link-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Daily Markdown Link Check
run-name: ${{github.event.pull_request.title}}
on:
schedule:
# Run everyday at 5:00 AM
- cron: "0 5 * * *"
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.mlc.config.json'
folder-path: '.'
max-depth: -1
17 changes: 17 additions & 0 deletions .github/workflows/pr-markdown-link-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: PR Markdown Link Check
run-name: ${{github.event.pull_request.title}}
on: [ pull_request ]
jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.mlc.config.json'
folder-path: '.'
max-depth: -1
check-modified-files-only: 'yes'
base-branch: 'main'
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
.DS_Store
!.kyma-project-io/
!templates/repository-template/.github
!.mlc.config.json
!.github/workflows/pr-markdown-link-check.yaml
!.github/workflows/daily-markdown-link-check.yaml
12 changes: 12 additions & 0 deletions .mlc.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"replacementPatterns": [
{
"_comment": "a replacement rule for all the in-repository references",
"pattern": "^/",
"replacement": "{{BASEURL}}/"
}
],
"timeout": "20s",
"retryCount": 5,
"fallbackRetryDelay": "30s"
}

0 comments on commit 570ba35

Please sign in to comment.