CI/CD で自動生成・デプロイを設定するには
このページでは、annai（ソースコードからユーザー向けマニュアルを自動生成するツール）と GitHub Actions（GitHub（ソースコードの共有・管理サービス）が提供する自動処理の仕組み）を連携し、ソースコード更新時にマニュアルの再生成と公開を自動で 行う環境を構築します。
手順
-
ターミナル（コマンドを入力する画面）を開き、プロジェクトのフォルダへ移動します。以下のコマンドを実行して、ワークフロー（自動処理の設定）ファイルを生成します。
annai init.github/workflows/annai.ymlが自動で作成されます。すでにannai initを実行済みの場合は、ファイルが存在するか確認しましょう。マニュアル生成と同時に作成したい場合はannai gen --with-ciも使えます。 -
GitHub のリポジトリページで「Settings」タブを開き、「Secrets and variables」から「Actions」を選びます。以下の2つのシークレット（外部に公開されな い秘密の設定値）を登録します。
Name Value CLOUDFLARE_API_TOKENCloudflare（Web サイトのホスティングサービス）の API トークン CLOUDFLARE_ACCOUNT_IDCloudflare のアカウント ID -
ワークフローファイルと annai.config.json を GitHub に反映します。
git add .github/workflows/annai.yml annai.config.json
git commit -m "ci: annai ワークフローを追加"
git push origin main -
GitHub のリポジトリページで「Actions」タブを開き、ワークフローが実行されていることを確認します。
ここまでの手順が完了すると、ソースコードを更新するたびにマニュアルが自動で再生成・公開される状態になります。
ワークフローが実行されない場合は、.github/workflows/annai.yml が main ブランチ（メインの開発ライン）に存在しているか確認します。
ワークフローが途中で失敗する場合は、シークレットの CLOUDFLARE_API_TOKEN と CLOUDFLARE_ACCOUNT_ID が登録されているか、annai.config.json の cloudflare.projectName が設定されているか確認します。