Skip to content

Commit

Permalink
added markdownlint run script
Browse files Browse the repository at this point in the history
  • Loading branch information
xHasKx committed Nov 25, 2023
1 parent ac9dbe3 commit 3bb28aa
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ jobs:
run: sudo npm install -g markdownlint-cli

- name: validate all markdown files
run: cd "${{ github.workspace }}" && markdownlint -p .gitignore .
run: cd "${{ github.workspace }}" && ./tests/run-markdownlint.sh
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ Standard MIT License, see LICENSE file for full text
* in file `./openwrt/Makefile`: change `PKG_VERSION:=X.Y.Z` and maybe `PKG_RELEASE:=1`
* copy file `./luamqtt-scm-1.rockspec` to `./rockspecs/luamqtt-X.Y.Z-1.rockspec` change `local package_version = "scm"`, `local package_version = "X.Y.Z"`
* run `./tests/run-luacheck.sh` and check output for errors
* run `./tests/run-markdownlint.sh` and check output for errors
* run `./tests/run-for-all-lua-versions.sh` and check output for errors
* run `./openwrt/make-package-without-openwrt-sources.sh` and check output for errors
* run `git commit`, `git tag vX.Y.Z`
Expand Down
6 changes: 6 additions & 0 deletions tests/run-markdownlint.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

# please install node.js runtime for your OS ( https://nodejs.org/ )
# then run `npm install -g markdownlint-cli` (maybe with sudo)

npx markdownlint-cli -p .gitignore .

0 comments on commit 3bb28aa

Please sign in to comment.