Atom の git 連携でコミットログにコミットテンプレートのコメントが載る不具合


はじめに

Atomのgit連携でコミットしたら以下のようなコミットログになっていた。

スクリーンショット 2019-02-13 20.55.05.png

\(^o^)/

筆者は絵文字コミット1を実践するためにコミットテンプレートを使っているんですが、コメントアウトされてる内容がそのままコミットログに載ってきています。


発生条件

以下の環境の場合に発生します。


  • Atom のバージョン: 1.34.0 (これより下のバージョンでも発生するかも)

  • Atom の GitHub 連携機能を使っている

  • git の commit テンプレートを使っている


問題の原因

atom/githug のリポジトリ2にissueが上がっていた。最新のリリースでは解消されている。

ところが、、、

$ apm list | grep github

├── github@0.23.3
├── open-on-github@1.3.1

atom をインストールしたときにバンドルされている atom/github バージョンが最新でないのでこの問題が依然継続している。


解決方法

atom/github を手動でインストールする。

$ apm install github

手動でインストールすんじゃねぇ!という警告が出ている。。


The github package is bundled with Atom and should not be explicitly installed.

You can run apm uninstall github to uninstall it and then the version bundled

with Atom will be used.


$ apm list | grep github

├── github@0.23.3
├── github@0.26.0

警告は気になりますが、筆者の環境では今のところ問題なく使えています(あまりおすすめできる方法じゃないかも)。

早く atom 側で対応してほしい。。


追記1

最新の atom のリポジトリの master を見ると github 連携の version 0.26.0 をチェックアウトするようになっている。次のリリースで対応されると思う。

https://github.com/atom/atom/blob/master/package.json#L68


追記2

pre-release 版 1.35.0-beta0 で解消されていました。

pre-release 版 1.35.0-beta0 でもだめですね。

$ apm list | grep github

├── github@0.24.0

最新の master からビルドしたものだと解消されていました。

$ apm list | grep github

├── github@0.26.0


参考