更新のお知らせは、どこを読めばいい?
リリース情報から、自分のサイトに関係する変更と必要な作業を見つけます。
目次
更新のお知らせでは、変更内容、自分のサイトへの影響、必要な作業を確認します。新しい版だけでなく、今使っている版から更新先までの変更も読みます。英語や開発用語は、下の表と見比べながら確認しましょう。
リリースノートは、その版で追加・修正・変更された内容をまとめた記録です。公式の更新ガイド(別タブで開く)から、公式のコードと変更履歴を保管する場所、GitHubのリリース情報へ進めます。
最新の1件だけでは、途中の変更を見落とす
たとえば、使っている版と更新先の間に複数のリリースがあれば、その間の変更も確認対象です。最初に現在の版と更新先の版をメモします。現在の版がわからない場合は、版番号の調べ方から確認してください。
また、EmDash本体とプラグインは、別々の版番号を持つことがあります。お知らせの対象がemdashなのか、特定のプラグインなのかを確かめます。Cloudflare用の@emdash-cms/cloudflareは、本体と対応する同じ版を揃える必要があります。
よく出る言葉を、作業に置き換える
| お知らせの言葉 | 読み取ること |
|---|---|
| Added / Feature | 新しく何ができるようになったか |
| Fixed / Fix | どんな不具合が直ったか |
| Changed / Breaking change | 今までの設定やコードを直す必要があるか |
| Deprecated | 今後使わなくなる予定の機能と、代わりの方法 |
| Migration | 保存データの構造を変更する必要があるか |
実際の見出しはリリースごとに異なります。単語を見つけたら、その下に書かれている対象条件と対応まで読みます。
更新予定を一覧にする道具もある
ここからは、サイトのファイルを管理している人の作業です。記事を書く担当者は、コマンドを実行せず、次の「必要な作業を、小さな表にする」へ進んでも構いません。
自分で調べる場合は、npmで準備したサイトのフォルダーをVS Codeで開きます。package.jsonが見える場所で、ターミナル → 新しいターミナルを選び、次を1行で実行します。起動中の開発サーバーへ文字を送らず、新しく開いたコマンド入力画面を使ってください。Windowsではコマンドプロンプトを選びます。入力画面の開き方
npx upgrade-emdash@latest --dry-run--dry-runは、実際の更新を行わずに予定を確認する指定です。更新ツールをまだ取得していない場合は、npmが取得の確認を出すことがあります。
表示された一覧から「パッケージ名」「更新先の版」「変更内容」を拾います。パッケージは、サイトで使うプログラムの部品です。予定をメモできたら、この確認は終わりです。実際の更新は、復旧方法などを用意してから行います。
この道具は、直接使っているEmDash関連パッケージについて、更新する版と変更内容を集めます。latestは実行時点の公開版を指すため、ガイドの作成時点とは結果が変わる場合があります。
必要な作業を、小さな表にする
「週末ノート」で使っている画像機能に修正が入る、という架空の例を考えます。
| 項目 | 記録の例 |
|---|---|
| 変更対象 | 画像の表示処理 |
| 自分への影響 | 記事の画像で使っている |
| 必要な修正 | 公式の説明にある設定変更を確認 |
| 更新後の確認 | 既存画像と、新しく登録した画像を開く |
知らない設定名が出てきたら、まずプロジェクト内で使っているかを調べます。自分で判断できない場合は、この表と該当する公式説明を制作担当者へ渡すと確認しやすくなります。
更新を実行したら、作業指示も読む
実際の更新では、ツールが.emdash/UPGRADE.mdに必要な作業をまとめます。自分のプロジェクト内の.emdashフォルダーにできる、UPGRADE.mdという作業メモです。--dry-runで予定を確認しただけでは、更新はまだ終わっていません。実際に更新した後、この作業メモをコードエディターで開いて、必要な作業を確認してください。
続きはアップデート手順です。プラグイン側の変更もある場合は、公式のプラグイン更新ガイド(別タブで開く)を合わせて読みます。