GithubアクションとMarkdownlintを使用したブログのビルドプロセスへのMarkdown Lintingの追加

読者を告白しましょう.私のマークダウンフォーマットは乱雑でした.私は汚いようなので、私はそれを修正し、自動化することを決めた.
解決策は次のとおりです.

台のmarkdownlintツール

A

の範囲内で私を縛らせるVSコード拡張

私が本当に彼らを必要とする場合に若干の例外を考慮に入れる規則ファイル

githubアクション私のプル要求の一部として実行するには、私を正直に保つ.

拡張モジュールのインストール
「拡張モジュール」ウィンドウで、markdownlintを探してインストールします
今、あなたはファイルを開くときに固定する必要があるものについてのフィードバックを得る開始します.それは本当に役立つ.

ルールファイルの作成

ルールをキャプチャするために、davidanson.vscode-markdownlintファイルをリポジトリのルートに追加します.あなたがする必要がある場合は物事が失敗として様々なルールをオフにすることができます.私の例のルールファイルcan be found here

ビルドの一部として実行する
このためにGithubアクションを利用します.

あなたのRIPOに.markdownrcでファイルを作成することによってGithubアクションのワークフローを作成します(この場合、.github/workflows/linting.ymlはフォルダです)

次のように変更し、値を変更します.

name: Housekeeping

on:
  push:
    branches:
      - main # Modify if you use a different main branch name, such as the legacy "master" name.
  pull_request:
    branches:
      - main # Modify if you use a different main branch name, such as the legacy "master" name.

jobs:
  linting:
    name: "Markdown linting"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        name: Check out the code
      - name: Lint Code Base
        uses: docker://avtodev/markdown-lint:v1
        with:
          args: "**/*.md"

このGitHubアクションファイルは何ですか?

それは私のメインブランチ

に対してどんな主要な枝コミットまたはどんなPRでも実行します

Itは、Ubuntuインスタンス

の上でGithubアクションを実行します

それはブログのすべての私のコードをチェックします.そして、それはすべてのMarkdownファイル

を含みます

は、Dockerハブに公開されているDockerコンテナを引っ張っています.これは他の誰かによって設定されています.

は、それがMarkdown Lint

の範囲内で走るファイルのコンテナへの引数で通過します

が実行されると、自動的に.github規則ファイルを見て、尊重します.そして、それが私のローカル環境と一致しています.

一旦このファイルをPRに運んだならば、私はリンギングが始まるのを見ました.

ウォッシュ、リンス、リピート
私がPRでこれを可能にした最初、私は多くの失敗を得ました.私は時間をかけて小さなコミットを作り続けました.

Voila!
今、私はVSコード内のローカルリンギングサポートを取得し、Githubアクションを介して時間のサポートをビルドします.無料で!1 .
ハッピーリンギング!

無料で、私は他の誰かの非常にハードワークのおかげで、彼らはしばしば補償され、サポートされている下にあることを意味します.オープンソースプロジェクトに貢献するか、またはあなたがよりよく働くことを可能にした著者またはグループに寄付することを考えてください.↩