Awesome

VOICEVOX Preview Pages

voicevox/voicevox のプレビューページを提供するためのリポジトリです。
対象ブランチ：

• main
• project-*
• プルリクエスト

動かす

1. GitHub Appsを作成します。

権限は以下の通りです：

• Pull requests：Read & write

Actionsで動かす

2. 作成したGitHub AppsのPrivate keyを取得し、リポジトリのSettings > Secrets にPRIVATE_KEYとして保存します。
3. .env.example の内容をリポジトリのSettings > Secrets にキーごとに保存します。

ローカルで動かす

2. 作成したGitHub AppsのPrivate keyを取得し、private-key.pemとして保存します。
3. .env.example をコピーして .env を作成します。内容はコメントを参照してください。

仕組み

sequenceDiagram
    actor user as ユーザー
    participant editor_fork as ユーザー/voicevox（フォーク）
    participant editor_main as voicevox/voicevox（main）
    participant preview_pages as voicevox/preview_pages

    user->>editor_fork: PRを出す
    
    note over editor_fork: ビルドを開始する
    activate editor_fork

    user-->>editor_main: pull_request_targetが発火する
    editor_main->>+preview_pages: update_pages.ymlを発火させる

    loop 
        preview_pages->>editor_fork: Jobの終了を問い合わせる
        editor_fork->>preview_pages: 
    end

    note over editor_fork: ビルドが完了する
    deactivate editor_fork
    preview_pages->>editor_fork: Artifactをダウンロードする
    editor_fork->>preview_pages: 

    note over preview_pages: Pagesにデプロイする
    deactivate preview_pages

ライセンス

LICENSE を参照してください。