2023/02/16

QMK FirmwareのフォークリポジトリにVer 0.18ブランチを作成する方法

目次

はじめに

ここでは、手順のみを載せています。
後述の参考章もご活用ください。

作成前準備

  1. あらかじめ、qmkコマンド、gitコマンドとGUIクライアント（GitHub Desktopなど）がインストールされているものとする
  2. リモートリポジトリとローカルリポジトリを更新、同期する
  3. タグ一覧を表示する：git tag
  4. 0.18.17 (0.18の最新版）が存在するか確認する
    存在しなかった場合、タグに対応するハッシュ値（例えば、0.18.17ならば133fe1c）を下記URLから確認する
    https://github.com/qmk/qmk_firmware/tags

ブランチ作成

タグを使用してブランチ作成

git checkout -b {A} refs/tags/{B}
{A}: upstreamのタグ一覧と被らない、任意のタグ名（例：v0.18）
{B}: 参照するタグ（例：0.18.17）

ハッシュ値を使用してブランチ作成

git checkout -b {A} {B}
{A}: upstreamのタグ一覧と被らない、任意のタグ名（例：v0.18）
{B}: 参照するハッシュ値（例：133fe1c）

QMK開発環境の設定

  1. git statusなどで身に覚えのない変更があれば、全て取り消す
  2. git diffを実行してsubmoduleに変更があれば、
    git submodule update -f --initを実行して取り消す
  3. qmk doctorを実行し、表示されたエラーや警告を出来るだけ解消する
    Ver 0.18.17の場合、avr-gccのバージョンダウン推奨は放置でいいかもしれない

環境テスト

  1. 試しに、任意のキーボードファームウェアをコンパイルしてみる
    qmk compile -kb {keyboard} -km {keymap}
  2. 成功したら、最後にリモートリポジトリに変更を反映して終わり

参考コマンド

作業ブランチを確認する

git branch
作業ブランチに*が付いている

ブランチを削除する

  1. 作業ブランチを確認
  2. 作業ブランチが削除対象ならば退避：git checkout {another-branch}
  3. ブランチ削除：git branch -D {delete-branch}
    -Dは、削除オプション + マージ済みでないブランチも対象

ブランチのログを表示する

git log
オプションなしの場合、作業ブランチに関するログのみ表示される

参考文献

タグ： 自作キーボード備忘録