Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/markdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Check Markdown For Errors

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
markdownlint:
name: markdownlint
runs-on: ubuntu-24.04
steps:
- name: Checkout repository
uses: actions/checkout@v4

# pinning to SHA to mitigate possible supply chain attack
- name: Run markdownlint-cli
uses: nosborn/github-action-markdown-cli@58bcfd1af530d87a13d51b76e6713b52602e3613 # v3.4.0
with:
files: .
config_file: ".markdownlint.yaml"

markdown-link-check:
name: Broken Links Check
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

# pinning to SHA to mitigate possible supply chain attack
- name: Check for broken links
uses: tcort/github-action-markdown-link-check@a800ad5f1c35bf61987946fd31c15726a1c9f2ba # v1.1.0
with:
use-quiet-mode: 'yes' # only show errors in output
use-verbose-mode: 'yes' # show detailed HTTP status for checked links
config-file: 'mlc_config.json'
33 changes: 0 additions & 33 deletions .github/workflows/markdownlint.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ then you just add a line to every git commit message:

using your real name (sorry, no pseudonyms or anonymous contributions.) and an
e-mail address under which you can be reached (sorry, no GitHub no-reply e-mail
addresses (such as username@users.noreply.github.com) or other non-reachable
addresses (such as `username@users.noreply.github.com`) or other non-reachable
addresses are allowed).

On the command line you can use `git commit -s` to sign off the commit.
Expand Down
7 changes: 7 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"ignorePatterns": [
{ "pattern": "^https://github.com/openhab/openhab-js/commit/.*" },
{ "pattern": "^https://github.com/openhab/openhab-js/pull/.*" },
{ "pattern": "^mailto:.*" }
]
}