GitHub AEのリリースノート
表示場所:https://docs.github.com/en/github-ae@latest/admin/release-notes
動作の仕組み
プレースホルダーコンテンツファイル
コンテンツファイルはcontent/admin/release-notes.mdにあります。 これは、特別なfrontmatterプロパティのlayout: release-notesを持ち、Markdownのコンテンツはありません。 リリースノートのソースはYAMLデータから得られます。
YAMLソース
リリースノートのソースデータはこのディレクトリ(data/release-notes/github-ae)にあります。
ディレクトリは月ごとに名付けられます。 YAMLファイルは週次のリリースの日付によって名付けられます。
それぞれのYAMLファイル内で、currentWeekという論理型のプロパティを設定しなければなりません。 このプロパティをtrueに設定できるファイルは、1つだけです。
パッチファイルは、オプションのdeprecated: trueプロパティによって個別に非推奨になる(すなわちdocsサイトで表示されなくなる)ことがあるので注意してください。
ミドルウェアの処理
YAMLデータはmiddleware/contextualizers/release-notes.jsで処理されてソートされ、contextオブジェクトに追加されます。
レイアウト
contextオブジェクトのデータは、layouts/release-notes.html及びincludes/github-ae-release-notes.htmlによってレンダリングされます。
リリースノートのページは、stylesheets/release-notes.scss内のCSSとjavascripts/release-notes.js内のクライアントサイド JavaScriptでカスタムデザインされています。
スキーマ
YAMLデータを検証するスキーマはtests/helpers/schemas/ghae-release-notes-schema.jsにあります。 必須及びオプションのプロパティを調べるには、このスキーマファイルを見てください。
このスキーマは、tests/linting/lint-files.js内のテストで適用されます。 データが検証をパスしなければ、このテストは失敗します。