クイックスタート

このページではGitHub Issue CMSの導入について説明します。

前提条件

以下のものを利用します。事前に準備しておいてください。

Go 1.25.0 以上
Issues が有効な GitHub リポジトリ
GitHub Access Token

手順

1. アプリケーションのインストール

以下のコマンドを実行します。

$ go install github.com/rokuosan/github-issue-cms@v1.0.0

2. コンフィグの作成

gic.config.yamlという名前でファイルを作成し、以下のような内容を記述します。

ここで指定するリポジトリは、Issueを取得するリポジトリです。 GitHub Access Tokenは、対象のリポジトリに対するアクセス権を持つものを準備してください。

github:
  username: '<YOUR_GITHUB_USERNAME>'
  repository: '<YOUR_GITHUB_REPOSITORY>'

output:
  articles:
    directory: 'content/posts'
    filename: '%Y-%m-%d_%H%M%S.md'
  images:
    directory: 'static/images/%Y-%m-%d_%H%M%S'
    filename: '[:id].png'
    url: '/images/%Y-%m-%d_%H%M%S'

3. 実行

以下のコマンドを実行して、対象のリポジトリからすべてのIssueをMarkdownに変換します。

$ github-issue-cms generate --token="<YOUR_GITHUB_ACCESS_TOKEN>"

もし、Issueに添付画像がある場合は以下のように出力されます。

$ tree --dirsfirst
.
├── content
│   └── posts
│       ├── 2023-12-21_151921.md
│       └── 2023-12-22_063216.md
├── static
│   └── images
│       ├── 2023-12-21_151921
│       │   └── 0.png
│       └── 2023-12-22_063216
│           ├── 0.png
│           ├── 1.png
│           └── 2.png
└── gic.config.yaml

出力されるファイルやディレクトリは、gic.config.yamlで変更することができます。

詳細ログを出したい場合は -v、デバッグログを出したい場合は -vv を利用してください。

gic.config.yamlの設定については、gic.config.yaml の設定を参照してください。

最終更新日 12月 25, 2021