CodexでCLIのリリースをX向けに告知

X向けのCodex

コマンドラインツールの新しいバージョンをXで告知すると、投稿に載せたコマンドを利用者がそのままコピーすることがあります。動かないコマンドは例を載せない場合より問題になり、リリースノートと実際のコードが食い違うこともあります。Codexは差分を読み、クリーンなディレクトリでコマンドを実行して、公開前に結果を示せます。Tarenoは確認済みの文章をプロジェクトのアカウント向けに下書き保存します。小さなCLIツールの保守担当者を例に、差分の確認から下書きと承認までを見ていきます。

例：コマンドラインツールのバージョン2.3を告知する

ログ検索ツールの保守担当者がバージョン2.3のタグを作成したとします。担当者はCodexに変更履歴と差分を読み、投稿案を作るよう依頼します。Codexは名前が変わったオプションと新しいサブコマンドを見つけ、文書化された更新コマンドを一時ディレクトリで実行します。そしてREADMEの例が古いオプション名を使っていると報告します。担当者がREADMEを修正した後、Codexはバージョン、新しいサブコマンド、1行の更新コマンドを含む270文字の投稿を書きます。文字数を確認してcreate_draftsでプロジェクトのXアカウント向けに保存し、担当者はTarenoで火曜15時の投稿を依頼します。

手順

1. 01

   リリースの範囲を指定する

   Codexに比較するタグの範囲または変更履歴の該当部分を伝えます。コードの差分とリリースノートを照合すれば、現在の動作と一致しない説明に気付けます。

2. 02

   重要な変更を一つ選ぶ

   フォロワーが今日試せる、利用者から見える変更を一つ選ぶよう依頼します。短い投稿に5つの機能を詰め込むと、それぞれの説明が不明瞭になりがちです。

3. 03

   コマンドを実行する

   クリーンなディレクトリでインストールまたは更新コマンドを実行し、正確な出力を示すようCodexに依頼します。公開するコマンドは事前に実行して確認してください。

4. 04

   文書とコードの食い違いを修正する

   README、リリースノート、ヘルプ文がコードと一致しない場合は、投稿する前に元の文書を修正します。そうしなければ利用者を誤った例に案内してしまいます。

5. 05

   280文字以内で書く

   バージョン、変更点、コマンドを含む280文字以内の投稿を依頼します。TarenoのX向け設定は書式をサポートしないため、コマンドはプレーンテキストになります。

6. 06

   保存し、日時を依頼して承認する

   Codexはlist_accountsでアカウントを確認し、create_draftsで文章を保存します。日付、時刻、IANAタイムゾーンを指定し、承認待ちの依頼をTarenoのダッシュボードで本人が承認します。

コピーして使えるプロンプト

Tarenoの投稿を準備するため、タグ[v2.2.0]と[v2.3.0]の間の変更と変更履歴の該当項目を読んでください。利用者に見える変更を、フォロワーが先に試しそうな順に並べ、変更履歴の説明とコードの動作が一致しない箇所を示してください。

クリーンな一時ディレクトリで、文書化された更新コマンド[コマンド]を実行し、続けてREADMEの例を使って新しいサブコマンド[名前]を試してください。正確な出力を示し、新しいオプション名で例が動くか、告知前に修正が必要かを報告してください。

Tareno向けに280文字以内のX投稿を書いてください。バージョン2.3、新しいサブコマンド、確認済みの更新コマンドをプレーンテキストで含めてください。文字数を数え、誇張表現を避け、リンクやハッシュタグに使える残りの文字数も知らせてください。

TarenoでXアカウント[プロジェクト名]を確認し、承認済みの文章を下書きとして保存してください。下書きIDと全文を返してください。私が投稿を確認して日付、時刻、タイムゾーンを指定するまでは、投稿日時を依頼しないでください。

避けるべき間違い

• 実行していないコマンドを公開すること。投稿に含める前にCodexに試させ、正確な出力を確認してください。
• READMEに古い名前が残っているオプションを使うこと。利用者が誤った例を参照しないよう、先にドキュメントを修正します。
• 5つの機能を一度に告知すること。フォロワーが短時間で理解し、試せる変更を一つ選んでください。
• Xで変化する可能性のある文字をコマンドに貼り付けること。承認前にTarenoの下書きで引用符とハイフンを確認します。