Skip to content

nulab/migrate-blg-gfm-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Backlog Markdown to GFM Markdown Migration Tool

Backlog Markdown で有効だった見出しを GitHub Flavored Markdown の見出しに変換するツールです。 指定したプロジェクトの課題概要および Wiki のデータを一括で変換します。

Backlog Markdown は #Title を見出しとして解釈していました。 GitHub Flavored Markdown は見出しとして解釈しないため # Title に修正します。

使い方

  1. 実行ファイルをダウンロード

    • Releases より最新版の実行ファイルをダウンロードします
      • Windows: migrate-blg-gfm-win.exe
      • macOS: migrate-blg-gfm-macos
  2. 実行

    • コマンドプロンプトからダウンロードしたファイルを実行します
  3. 設定入力

    • Backlog スペース(例:yourspace.backlog.com
    • API キー
    • プロジェクトコード
    • ドライランモード(Y/n)

API キーの取得方法

  1. Backlog にログインする
  2. 個人設定ページから API ページを開く
  3. API キーを生成する

ドライランモード

推奨: 初回実行時はドライランモード(Y)を選択してください。

  • ドライランモード(Y): 変更内容をプレビューのみ(実際の更新は行わない)
  • 実行モード(N): 実際に Backlog を更新

ログ

実行結果はmigration.logファイルに保存されます。

免責事項

本ツールは十分な検証を行ったうえで提供しておりますが、すべての利用環境において不具合や不都合が生じないことを保証するものではありません。 ツールのご利用によって生じたいかなる損害についても、当社は責任を負いかねます。

ご利用に際しては、必ずドライランモードで事前に動作をご確認いただいたうえで、本番環境への適用をご判断ください。


開発者向け情報

要件

  • Node.js 22 以上
  • Backlog API キー

インストール

npm install

開発モード

npm run dev

ビルド

npm run build
npm start

実行ファイル作成

タグをつけると自動的に Windows/macOS 用の実行ファイルが作成されます。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors