ブックマーク / future-architect.github.io (1)

  • CircleCIでMarkdownのリンク切れを自動検知する | フューチャー技術ブログ

    はじめにフューチャー棚井龍之介です。 私のチームでは、「システムの設計情報」や「実装に関わる業務知識」などを、README.md に整理して GitHub 管理しています。 設計資料や業務系のドキュメントが蓄積され、何度も更新され続けることに伴い、「あれ、この資料のリンクが切れてる。オリジナルのファイルはどこだっけ?」と探す機会が増えてきました。 来ならば PullRequest のレビュー時に気付くべきですが、ファイル名のちょっとしたスペルミスや資料パスの変更などだと、目視でのチェックには限界があります。 こういった状況への対応として「リンク切れを自動検知する」ために、CircleCIMarkdown ファイルのリンク切れを検知できるようにしました。 完成版コード<img src=”https://github-link-card.s3.ap-northeast-1.amazon

    CircleCIでMarkdownのリンク切れを自動検知する | フューチャー技術ブログ
    reteria
    reteria 2021/04/22
    textlint使ってチェックしたほうが良いんでは?と思ったけどそこまで必要ないとかもあるか。https://github.com/textlint-rule/textlint-rule-no-dead-link
  • 1