SakeSaySo の iOS および Android アプリ は、主に次の 2 つのリポジトリ方式でカスタムコンテンツを扱えるよう設計されています。
- コミュニティリポジトリ: コミュニティ GitHub リポジトリ への参加は簡単です。このリポジトリはアプリに初期設定されており、プルリクエストがマージされると自動 GitHub Action によって検索インデックスが更新されます。
- カスタムリポジトリ: 個人向けに調整した学習体験のために、
Settings -> Advanced Settings -> Add Repositoryからカスタムリポジトリを追加できます。
カスタムリポジトリのセットアップ
アプリがカスタムリポジトリを利用するには、HTTP サーバー経由でアクセスできる必要があります。そこでは、各マニフェストを列挙した index.json をホストします。マニフェスト一覧には、相対パスで参照されるストーリー .zip ファイルと、整合性確認および更新追跡用の正しい sha256 チェックサムが必要です。
GitHub でホストする
GitHub でも、コミュニティリポジトリと同様にカスタムリポジトリをホストできます。GitHub 上のリポジトリには次の形式を使ってください。
name: [repository name]
uri: https://api.github.com/repos/<username or organization>/<repository name>/contents/
必要に応じて weburl を指定すると、公開リポジトリの場合にリポジトリページに情報アイコン (i) が表示され、閲覧可能な GitHub ページへリンクできます。
weburl: https://github.com/<username or organization>/<repository name>
ブランチ別コンテンツを使う場合（たとえばテスト用）は次のようにします。
branch: [branch name]
非公開リポジトリにアクセスする
- Basic 認証: Basic 認証保護されたサーバーでは、ユーザー名とパスワードをリポジトリ URL に含めます。
https://username:[email protected]/my/custom/repository
- GitHub PAT トークン: GitHub リポジトリでは、認証に Personal Access Token (PAT) を使います。トークンはアプリ内に直接追加します。
github_pat_[your_token]
注: 現在アプリが非公開リポジトリへのアクセスで対応しているのは、Basic 認証と GitHub PAT トークンです。