Skip to content

Latest commit

 

History

History
17 lines (9 loc) · 865 Bytes

php_documentor.md

File metadata and controls

17 lines (9 loc) · 865 Bytes

phpDocumentor

baserCMSでは、クラスリファレンス の作成に phpDocumentor を使用しています。

デプロイ

リリース時に、GitHub Actions によって自動的にクラスリファレンスが生成されます。

デプロイの設定は、.github/workflows/php_documentor.yml に記述されています。

なお、デプロイの流れは次のとおりです。

  1. Docker を使用して、phpDocumentor を実行するコンテナを起動します。
  2. phpDocumentor によって、クラスリファレンスが生成されます。
  3. 生成されたクラスリファレンスを、baserproject.github.io レポジトリに、git push することでデプロイします。