chores: markdownlint を CI に設定する#298
Open
m-tsuru wants to merge 3 commits into
Open
Conversation
ryu22e
reviewed
Oct 2, 2025
| config: '.markdownlint-cli2.jsonc' | ||
|
|
||
| # 3. 変更されたファイルをコミット&プッシュ | ||
| - name: Commit and push changes |
Member
There was a problem hiding this comment.
GitHub Actions経由でのgit pushだとmdlint.ymlでパーミッションの変更の設定が必要になってしまうので、たぶんこの内容だとgit pushでエラーになります。
stefanzweifel/git-auto-commit-actionのドキュメントによると、以下の設定を書いているようです。
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push the
# added or changed files to the repository.
contents: writeただ、ちゃんと動くか動作確認が大変そうなので、このmdlint.ymlの中では自動修正まではやらないで、ルール違反のmarkdownがあったらエラー扱いする程度でいいかと思いますー。
自動修正をやりたいなら、pre-commitを使ってローカルでgit commitするときにmarkdownlint-cli2を実行させるようにようにする手があるかと思います。
設定例: https://github.com/DavidAnson/markdownlint-cli2#pre-commit
Contributor
Author
There was a problem hiding this comment.
pre-commit を設定するとなると,ローカルの環境で え,待って,そうである必要がない?markdownlint-cli2 をインストールすることをさせなければなりませんが,なんとなくこっちの都合でそれに付き合わせるのも変な感じですので,エラーを吐かせるぐらいがちょうど良さそうですね.方針をその方向に変更します.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR resolves #279.
チケットへのリンク
#279
このレビューで確認して欲しい点