-
Notifications
You must be signed in to change notification settings - Fork 33
chores: markdownlint を CI に設定する #298
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
m-tsuru
wants to merge
3
commits into
pyconjp:master
Choose a base branch
from
m-tsuru:mdlint
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: Deploy to Server | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| markdownlint: | ||
| name: markdownlint-cli2-action | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # 1. リポジトリのコードをチェックアウト | ||
| - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0 | ||
|
|
||
| # 2. markdownlint を実行し、ファイルを自動修正 | ||
| - name: Run markdownlint and fix | ||
| uses: DavidAnson/markdownlint-cli2-action@992badcdf24e3b8eb7e87ff9287fe931bcb00c6e # v20.0.0 | ||
| with: | ||
| globs: | | ||
| source/organize/**/*.md | ||
| source/textbook/**/*.md | ||
| fix: true | ||
| config: '.markdownlint-cli2.jsonc' | ||
|
|
||
| # 3. 変更されたファイルをコミット&プッシュ | ||
| - name: Commit and push changes | ||
| uses: stefanzweifel/git-auto-commit-action@b863ae1933cb653a53c021fe36dbb774e1fb9403 # v5.2.0 | ||
| with: | ||
| # コミットメッセージ | ||
| commit_message: "style: Apply markdownlint changes [skip ci]" | ||
| # コミットするユーザー名 | ||
| commit_user_name: "github-actions[bot]" | ||
| # コミットするメールアドレス | ||
| commit_user_email: "github-actions[bot]@users.noreply.github.com" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "config": { | ||
| "MD013": false, | ||
| "MD024": false, | ||
| "MD041": false | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub Actions経由でのgit pushだとmdlint.ymlでパーミッションの変更の設定が必要になってしまうので、たぶんこの内容だとgit pushでエラーになります。
stefanzweifel/git-auto-commit-actionのドキュメントによると、以下の設定を書いているようです。
ただ、ちゃんと動くか動作確認が大変そうなので、このmdlint.ymlの中では自動修正まではやらないで、ルール違反のmarkdownがあったらエラー扱いする程度でいいかと思いますー。
自動修正をやりたいなら、pre-commitを使ってローカルでgit commitするときにmarkdownlint-cli2を実行させるようにようにする手があるかと思います。
設定例: https://github.com/DavidAnson/markdownlint-cli2#pre-commit
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pre-commit を設定するとなると,ローカルの環境でえ,待って,そうである必要がない?markdownlint-cli2をインストールすることをさせなければなりませんが,なんとなくこっちの都合でそれに付き合わせるのも変な感じですので,エラーを吐かせるぐらいがちょうど良さそうですね.方針をその方向に変更します.