リポジトリ内のファイルをBacklogのドキュメントに同期するGitHub Actionsワークフローです。
.github/workflows/sync-backlog-documents.yml # ワークフロー定義
scripts/sync-backlog-documents.py # 同期スクリプト(Python)
requirements.txt # Python依存パッケージ
doc/ # 同期対象ドキュメント
Backlogの個人設定 > API > APIキーの登録からAPIキーを発行してください。
リポジトリのSettings > Secrets and variables > Actionsから、以下のシークレットを登録してください。
| シークレット名 | 内容 | 例 |
|---|---|---|
BACKLOG_API_KEY |
BacklogのAPIキー | abcdefghijklmn |
BACKLOG_SPACE_ID |
Backlogスペース名 | example |
BACKLOG_PROJECT_ID |
BacklogプロジェクトID(数値) | 12345 |
BACKLOG_DOMAIN |
Backlogドメイン | backlog.jpまたはbacklog.com |
./doc/ディレクトリにファイルを配置してください。ファイル名(拡張子除く)がBacklogドキュメントのタイトルになります。
| トリガー | 対象ファイル |
|---|---|
mainブランチへのpush(doc/配下の変更時) |
変更されたファイルのみ(差分検出) |
手動実行(workflow_dispatch) |
doc/配下の全ファイル |
| 操作 | 挙動 |
|---|---|
| ファイル追加 | Backlogにドキュメントを新規作成 |
| ファイル更新 | 既存ドキュメントを削除して再作成(Backlog APIに更新APIが存在しないため) |
| ファイル削除 | Backlog上の対応するドキュメントを削除 |