Skip to content

Commit

Permalink
Merge pull request #4 from blooper05/add-action-markdownlint
Browse files Browse the repository at this point in the history
👷 ci(actions): Add `markdownlint` job
  • Loading branch information
blooper05 authored Jun 8, 2022
2 parents e4df4ea + bd01b13 commit 6be2906
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .github/workflows/reviewdog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
43 changes: 43 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,15 @@ 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.
#### [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.
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
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
Expand All @@ -107,11 +109,14 @@ 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)
### 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)

0 comments on commit 6be2906

Please sign in to comment.