Gitでのブランチの説明

ブランチに「説明」を付ける方法はGitにありますか？

説明的な名前を使おうとしていますが、単一のブランチでしばらく作業すると、他のトピックブランチをいくつか作成した理由を思い出すことが時々あります。私はブランチにわかりやすい名前を付けようとしていますが、「説明」（ブランチの目的についての短いメモ）がいいと思います。

Git 1.7.9はこれをサポートしています。1.7.9のリリースノート：

 *「git branch --edit-description」を使用して説明テキストを追加できます
   トピックブランチとは何かを説明します。

あなたがコミットして、2011年9月に戻って導入されたその機能を見ることができます6f9a332、739453a3、b7200e8：

struct branch_desc_cb {
  const char *config_name;
  const char *value;
};

--edit-description::

エディターを開き、テキストを編集して、ブランチの目的を説明し、他のさまざまなコマンド（などrequest-pull）で使用します。

切り離されたHEADブランチでは機能しないことに注意してください。

その説明は、スクリプト要求プルで使用されている：参照c016814783をコミットするだけでなく、git merge --log。

request-pull 標準出力への2つのコミット間の変更を要約するために使用されるスクリプトであり、生成された要約に特定のURLを含めます。

[@AchalDaveから]残念ながら、説明はconfigに保存されているためプッシュできません。チームのブランチを文書化するためには役に立たないからです。

あなたがいる場合か READMEを使用して終了、作成Gitのエイリアス変更git checkoutあなたのREADMEは、あなたが枝を切り替えるたびに表示されるように。

たとえば、これを[エイリアス]の下の〜/ .gitconfigに追加します

cor = !sh -c 'git checkout $1 && cat README' -

この後は、実行することができますgit cor <branch_name>スイッチブランチにとあなたに切り替えている枝のREADMEを表示します。

git branch --edit-descriptionブランチの説明を設定または編集するために使用します。

以下は、ブランチに似ているgit branchが説明が追加されたシェル関数です。

# Shows branches with descriptions
function gb() {
  current=$(git rev-parse --abbrev-ref HEAD)
  branches=$(git for-each-ref --format='%(refname)' refs/heads/ | sed 's|refs/heads/||')
  for branch in $branches; do
    desc=$(git config branch.$branch.description)
    if [ $branch == $current ]; then
      branch="* \033[0;32m$branch\033[0m"
     else
       branch="  $branch"
     fi
     echo -e "$branch \033[0;36m$desc\033[0m"
  done
}

ここでは何であるgb画像腐敗場合にテキストとしてここに示されている、次のようになります。

$ gb
* logging Log order details.  Waiting for clarification from business.
  master 
  sprocket Adding sprockets to the parts list.  Pending QA approval.

そして画像として、色を見ることができます：

で定義されたカスタムマージドライバーで設定されている場合、Chris JREADMEによって提案されたものが機能します。 そうすることで、マージ時にローカルバージョンのが常に保持されます。.gitattribute
README

ブランチの「説明」は、そのメタデータに関連付けられた「コメント」とも呼ばれ、サポートされていません。

少なくとも、READMEファイルを使用すると、どのブランチでも次のことができます。

$ git show myBranch:README

READMEがREPOのルートディレクトリにある場合、が使用するパスgit showは、そのリポジトリの最上位ディレクトリからの絶対パスであるため、任意のパスから機能します。

ここには2つの一般的な提案があります。

1. git branch --edit-description：プッシュできないので、これは好きではありません。たぶん私が作成したブランチが何をするか覚えているかもしれませんが、私のチームは確かにできません。
2. READMEファイルpr ブランチ。これはマージ中の苦痛です：競合をマージする傾向が非常に強く、README機能ブランチをマージするときにブランチからプルインします。ブランチ間の差異もまた苦痛です。

孤立したbranches-readmeブランチを作成することにしました。孤立したブランチは、独自の個別の履歴をgh-pages持つブランチです。Githubのブランチからそれらを知っているかもしれません。この孤立したブランチには、単一のREADMEファイルが含まれています。次のような内容です。

master:
    The default branch
mojolicious:
    Start using Mojolicious
branch-whatever:
    Description of the whatever branch

プッシュ可能で、マージに対応しています。READMEブランチからの表示：

git show branches-readme:README

不利な点は、更新したいときに奇妙な孤立したブランチをチェックアウトする必要があることREADMEと、READMEブランチの名前が変更されたり、来たり入ったりするときにが自動更新されないことです。しかし、それは私たちにとっては問題ありません。

次のようにします。

git checkout --orphan branches-readme
# All the files from the old branch are marked for addition - skip that
git reset --hard
# There are no files yet - an empty branch
ls
vi README
# put in contents similar to above
git add README
git commit -m "Initial description of the branches we already have"
git push origin branches-readme
# get all your original files back
git checkout master

同様に、個々のチームメンバーはbranches-$user、チームにプッシュしない限り、必要に応じて、自分のプライベートブランチを表す独自の孤立したブランチを作成することもできます 。

さらにツールを使用すると、これをの出力と統合することもできgit branchます。そのために、おそらくREADME.yamlプレーンではなくファイルが考えられますREADME。

git config --global --add alias.about '!describe() { git config branch."$1".description; }; describe'

コマンドは、グローバルオプションalias.aboutをシェル式として定義します。git about <branch>リポジトリで実行すると、設定されている場合はブランチの説明が表示されます。

以下は、git branchesGreg Hewgillが言及したコマンドの可能な実装です。

#!/usr/bin/perl

sub clean {
    map { s/^[\s\*]*\s// } @_;
    map { s/\s*$// } @_;
    return @_;
}

sub descr {
    $_ = `git config branch.@_.description`;
    s/\s*$//;
    return $_;
};
sub indent {
    $_ = shift;
    s/^/      /mg;
    return $_;
};

my @branches = clean `git branch --color=never --list`;
my %merged = map { $_ => 1 } clean `git branch --color=never --merged`;

for my $branch (@branches) {
    my $asis = `git branch --list --color=always $branch`;
    $asis =~ s/\s*$//;
    print "  $asis";
    print " \033[33m(merged)\033[0m" if ($merged{$branch} and $branch ne "master");
    print "\n";

    print indent descr $branch;
    print "\n";
    print "\n";
}

ここだgit aliasあなたにセットし、現在のブランチの読み取り記述の両方をすることができています：

git config --global --add alias.about '!describe() { msg="$1"; git config branch."$(git rev-parse --abbrev-ref HEAD)".description ${msg:+"$msg"}; }; describe'

使用法/例：

(develop) $ git about
(develop) $ git about message
(develop) $ git about
message
(develop) $ git about "this is a new message"
(develop) $ git about
this is a new message
(develop) $ git checkout -b test_branch
Switched to a new branch 'test_branch'
(test_branch) $ git about
(test_branch) $ git about "this is the test branch"
(test_branch) $ git about
this is the test branch
(test_branch) $ git checkout -
Switched to branch 'develop'
Your branch is up to date with 'origin/develop'.
(develop) $ git about
this is a new message

私を始めた答えを@Felicioに特に感謝します。

タグにコメントを付けることができます：

git tag -m 'this was a very good commit' tag1

慣例により、ブランチ名に関連するタグを付けるか、タグ-fを使用して、トピックブランチの先頭にコメントタグを付けます。

ブランチを作成したいとします

git branch branch-20200328
git notes add branch-20200328 -m "This branch is for whatever"
git notes show branch-20200328

この機能は現在サポートされていません。私はあなたの最善の策は、あなたが欲しい情報を持っているブランチで説明テキストファイル、基本的にREADMEを作成することだと思います。

選択した答えは私にはやり過ぎのようです。私は、通常のソース管理ファイルであるブランチごとの説明ファイルを維持する傾向があります。たとえばmaster.txt、dev.txt扱いにくい数やブランチがある場合は、階層を作成してより適切に整理します。

ただ使用する：

git config branch.<branch name>.description

クレジットの期日にクレジットを付与するには：https : //glebbahmutov.com/blog/git-branches-with-descriptions/

使用する

git branch --list -v

上流のブランチを表示するには：

git branch --list -vv

-rリモートのみ-aを表示するか、リモートとローカルを表示するように追加します。