Quick Start

This page explains how to get started with GitHub Issue CMS.

Prerequisites

The following are required. Please prepare them in advance.

Go 1.25.0 or higher
GitHub repository with Issues enabled
GitHub Access Token

Steps

1. Install the application

Run the following command:

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

2. Create configuration file

Create a file named gic.config.yaml and write the following content:

The repository specified here is the one from which issues will be fetched. Please prepare a GitHub Access Token that has access permissions to the target repository.

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. Execute

Run the following command to convert all issues from the target repository to Markdown:

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

If issues have attached images, the output will be as follows:

$ 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

The output files and directories can be changed in gic.config.yaml.

If you want verbose logs, use -v. For debug logs, use -vv.

For more information about gic.config.yaml settings, please refer to gic.config.yaml Configuration.

Last updated on December 25, 2021