From b115aedd5226e870ef8f5041bde6512f7d7428df Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 12:08:20 +0900 Subject: [PATCH 1/5] =?UTF-8?q?=F0=9F=91=B7=20ci(actions):=20Add=20`markdo?= =?UTF-8?q?wnlint`=20job?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/reviewdog.yml | 10 ++++++++++ README.md | 1 + 2 files changed, 11 insertions(+) diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml index 0c95f1a..977ab15 100644 --- a/.github/workflows/reviewdog.yml +++ b/.github/workflows/reviewdog.yml @@ -49,6 +49,16 @@ jobs: reporter: github-check level: warning + markdownlint: + name: runner / markdownlint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: reviewdog/action-markdownlint@v0 + with: + reporter: github-check + level: warning + misspell: name: runner / misspell runs-on: ubuntu-latest diff --git a/README.md b/README.md index ef1ba2d..b41b6f8 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,7 @@ Supported linters: - [reviewdog/action-shfmt](https://github.com/reviewdog/action-shfmt) - [reviewdog/action-actionlint](https://github.com/reviewdog/action-actionlint) - [reviewdog/action-yamllint](https://github.com/reviewdog/action-yamllint) +- [reviewdog/action-markdownlint](https://github.com/reviewdog/action-markdownlint) - [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell) - [reviewdog/action-alex](https://github.com/reviewdog/action-alex) From a8c4a64ea18caa2da6a92e4ef47bf0408693fab7 Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 12:09:11 +0900 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=9A=A8=20style(markdownlint):=20Initi?= =?UTF-8?q?al=20setup=20of=20`markdownlint`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .markdownlint.yml | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .markdownlint.yml diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..e5dd1de --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,43 @@ +# refs. https://github.com/DavidAnson/markdownlint/blob/HEAD/schema/.markdownlint.yaml +--- +default: true + +# MD003/heading-style/header-style - Heading style +MD003: + # Heading style + style: atx + +# MD004/ul-style - Unordered list style +MD004: + # List style + style: dash + +# MD007/ul-indent - Unordered list indentation +MD007: + # Spaces for indent + indent: 4 + +# MD013/line-length - Line length +MD013: + # Number of characters for code blocks + code_block_line_length: 120 + +# MD029/ol-prefix - Ordered list item prefix +MD029: + # List style + style: ordered + +# MD035/hr-style - Horizontal rule style +MD035: + # Horizontal rule style + style: --- + +# MD049/emphasis-style - Emphasis style should be consistent +MD049: + # Emphasis style should be consistent + style: asterisk + +# MD050/strong-style - Strong style should be consistent +MD050: + # Strong style should be consistent + style: asterisk From 246a71f820af4391f310ea39c1561f294cc8367e Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 12:15:21 +0900 Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=9A=A8=20style(markdownlint):=20Fix?= =?UTF-8?q?=20the=20`MD022`=20warning=20from=20`markdownlint`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b41b6f8..fef6e6b 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,7 @@ jobs: ### Release #### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr) + You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch). Pushing tag manually by yourself also work. @@ -112,6 +113,7 @@ Supported linters: - [reviewdog/action-alex](https://github.com/reviewdog/action-alex) ### Dependencies Update Automation + This repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update reviewdog version. From fad1bedb74fa4ab4292d0f5549431e9fbf45a8b6 Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 12:19:58 +0900 Subject: [PATCH 4/5] =?UTF-8?q?=F0=9F=9A=A8=20style(markdownlint):=20Fix?= =?UTF-8?q?=20the=20`MD013`=20warning=20from=20`markdownlint`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fef6e6b..496b82c 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,8 @@ Pushing tag manually by yourself also work. #### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver) -This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3. +This action updates major/minor release tags on a tag push. +e.g. Update v1 and v1.2 tag when released v1.2.3. ref: https://help.github.com/en/articles/about-actions#versioning-your-action ### Lint - reviewdog integration @@ -114,7 +115,8 @@ Supported linters: ### Dependencies Update Automation -This repository uses [reviewdog/action-depup](https://github.com/reviewdog/action-depup) to update -reviewdog version. +This repository uses [reviewdog/action-depup] to update reviewdog version. + +[reviewdog/action-depup]:https://github.com/reviewdog/action-depup ![reviewdog depup demo](https://user-images.githubusercontent.com/3797062/73154254-170e7500-411a-11ea-8211-912e9de7c936.png) From bd01b13051cffb7c0c58ec68322e97d249814c45 Mon Sep 17 00:00:00 2001 From: blooper05 Date: Wed, 8 Jun 2022 12:21:02 +0900 Subject: [PATCH 5/5] =?UTF-8?q?=F0=9F=9A=A8=20style(markdownlint):=20Fix?= =?UTF-8?q?=20the=20`MD034`=20warning=20from=20`markdownlint`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 496b82c..6801cbb 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ Pushing tag manually by yourself also work. This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3. -ref: https://help.github.com/en/articles/about-actions#versioning-your-action +ref: ### Lint - reviewdog integration