【ITニュース解説】Set up blog-kit: publish to dev.to with a leak check in the way

blog-kitは、開発者向けの技術ブログプラットフォームであるdev.toに記事を公開するための便利なツールである。このツールは、記事の公開作業を効率化するだけでなく、重要な秘密情報が誤って公開されてしまうのを防ぐ「リークチェック」機能が最大の特長である。システムエンジニアが日々の業務で作成する技術メモや資料には、社内のネットワークアドレスや設定情報、あるいはテスト用に作成したAPIキーなど、外部に公開すべきではない情報が意図せず含まれていることがある。このような情報がうっかり公開されてしまうと、企業のセキュリティ上の大きな問題や、個人の信頼を損なう事態につながる可能性がある。blog-kitは、そうした致命的なミスを未然に防ぐために設計された、まさに開発者のための安全装置と言える。

このツールは主に三つの機能を持っている。一つ目は、dev.toが提供するAPIを利用して記事を投稿することだ。これにより、手動で記事をアップロードする手間が省け、定型的な公開作業を自動化できる。二つ目は、記事に含める図を効率的にレンダリングする機能である。複雑なシステム構成図などを美しく、そして鮮明に記事内に表示することを支援する。三つ目は、記事のアイキャッチとなるカバー画像を生成する機能だ。これらの機能をまとめて提供することで、記事作成から公開までの一連のワークフローをスムーズにし、開発者がコンテンツ作成に集中できる環境を提供する。

blog-kitのセットアップは非常に簡単で、およそ5分で完了できるとされている。これは、毎週、まっさらなUbuntuというLinux環境で動作確認が行われていることからも、その安定性と手軽さが裏付けられている。基本的な動作にはPython 3とその標準ライブラリのみが必要であり、追加で複雑なソフトウェアをインストールする必要がほとんどないため、多くのシステムエンジニアの環境で導入しやすい。使い始めるには、まずGitHubというコード共有サービスからツールのコード一式を自分のコンピューターにダウンロードし、そのプログラムが保存されたディレクトリに移動する。その後、用意した記事のファイルを指定してPythonスクリプトを実行するだけで、blog-kitを利用できる。

記事を実際に公開する前に、安全に内容を確認できる「ドライラン」機能が備わっている。これは、指定された記事ファイルからタイトル、タグ、文字数といった情報を読み取り、公開後のイメージを表示してくれるが、実際に記事がdev.toに送信されることはない。つまり、公開ボタンを押す前に、記事の内容や形式に問題がないかをじっくりと確認できる。誤って未完成の記事や間違いのある記事を公開してしまうリスクを防ぐため、このツールは明示的に公開を指示しない限り、常にドライランモードで動作するように設計されている。

blog-kitの最も重要な機能は、前述した「リークチェック」である。これは、記事の中に外部に公開すべきではない情報が含まれていないかを自動的に検出する機能だ。具体的には、社内ネットワークで使用されるプライベートIPアドレス（例: 10.1.2.3のような内部でのみ使われるアドレス）、アプリケーションの認証に使うAPIキー、システムのアクセスに必要なパスワードのような「秘密」と判断されるキーワードや特定の形式の文字列をチェックする。もし記事の中にこれらの情報が発見された場合、ツールは公開を拒否し、どの情報が見つかったかを警告として表示する。この機能はドライラン時でも動作するため、実際に公開される前に情報漏洩のリスクを確実に排除できる。もしリークチェックで引っかかった場合は、実際の情報を一般的な例（例えば、ドキュメントでよく使われる192.0.2.xのようなIPアドレス）に置き換えるか、あるいは特別な理由がある場合にのみ--forceオプションを使って強制的に公開することも可能である。この機能は、一度公開してしまうと取り返しがつかない情報漏洩のミスを未然に防ぎ、開発者の安全な情報発信を支える生命線となる。

ドライランで内容とリークチェックに問題がないことを確認したら、いよいよ記事を公開する。公開するには、実行コマンドに--publishオプションを追加し、さらにdev.toのAPIキーを環境変数として設定する必要がある。このAPIキーは、ユーザーがdev.toに記事を投稿する権限を持っていることを証明するためのもので、他人には決して知られてはならない重要な情報だ。記事が正常に公開されると、ツールはdev.toから実際に投稿された記事を読み戻し、公開日時を表示してくれる。これは、dev.toのAPIが記事を作成した際に「公開済み」という情報を示さない場合があるため、本当に公開されたかどうかをユーザーが確実に確認できるようにするための工夫である。

記事に図を含める場合にも、blog-kitは役立つ機能を提供する。例えば、SVG形式で作成した図を高品質なPNG形式に変換するためのツールを簡単に導入できる。図は、描画時は880ピクセルの幅で作成し、レンダリング時には1760ピクセルという高い解像度で出力することで、スマートフォンや高解像度ディスプレイなど、様々なデバイスで鮮明に表示されるようになる。さらに、図の背景色は白に設定することが推奨されている。これは、dev.toが提供する「ダークモード」に対応するためだ。ダークモードでは、ウェブサイトの背景色が暗くなるため、もし図が透明な背景に暗い文字で描かれていると、文字が背景色に溶け込んでしまい、見えなくなってしまう可能性がある。白い背景にしておけば、どちらのモードでも図がはっきりと見えるようになり、読者にとって読みやすい記事となる。

通常、ソフトウェア開発では、継続的インテグレーション（CI）という自動テストの仕組みが使われ、プログラムの品質が常にチェックされる。しかし、blog-kitのすべての機能がCIで完全にテストできるわけではない。特に、実際に記事をdev.toに公開する機能や、AIを使ってカバー画像を生成する機能は、本物のAPIキーや特定のサーバーへのアクセスが必要なため、CIの自動実行だけでは完全に確認することが難しい部分がある。週次で自動テストが実行されるのは、記事の送信直前までであり、最終的な公開部分や複雑な画像生成は、人の手による確認や、別途管理された環境が必要となる。このツールは、筆者自身のホームラボで蓄積されたメモやログ、リポジトリからAIの支援を受けて作成され、最終的には人間がレビュー・編集を行って公開されている点も特徴である。blog-kitは、単なる記事公開ツールにとどまらず、情報漏洩という致命的なミスを防ぎつつ、効率的かつ高品質な記事作成を支援する、システムエンジニアにとって非常に価値のあるツールと言えるだろう。