Draft: ci: expose mkdocs artifacts as 'docs preview' in MR UI

inagakirequested to merge
inagaki.kazuhisa/frontistr_documents:kinagaki/expose-mkdocs-preview into main

概要

mkdocs ジョブのアーティファクトに expose_as: "docs preview" を追加し、MR画面の右サイドバーおよびOverviewに「docs preview」という名前で生成されたドキュメントサイトへの直接リンクを表示するようにする。

背景

現状、MRレビュー時に変更後のドキュメントをプレビューする手段が以下に限られており、レビュワーの負担になっている。

  • パイプライン → ジョブ → 「Browse」からアーティファクトを辿る
  • ローカルにfrontistr_documentsをクローンしmkdocs serveする

expose_as は単一行追加でMR画面から1クリックでプレビューに到達できるようにするGitLab標準機能である（公式ドキュメント）。

変更内容

.gitlab-ci.yml の mkdocs ジョブ artifacts: に以下1行を追加:

    expose_as: "docs preview"

pages-main / pages-tag ジョブの挙動には影響しない。

動作確認

  • YAMLシンタックスの妥当性（mkdocs ジョブの artifacts 直下に適切にネスト）
  • MR UI 右サイドバーの「Merge request pipeline」エリアに docs preview リンクが表示されること
  • リンクから生成された site/ が参照できること
  • pages-main（mainブランチ）のデプロイが従来通り動作すること

Merge request reports