Zweigbeschreibungen in Git

Question

Gibt es in Git eine Möglichkeit, eine "Beschreibung" für Zweige zu haben?

Ich versuche zwar, beschreibende Namen zu verwenden, aber wenn ich eine Zeit lang an einem einzigen Zweig arbeite, kann ich mich manchmal nicht mehr daran erinnern, warum ich einige der anderen Themenzweige erstellt habe. Ich versuche, beschreibende Namen für die Zweige zu verwenden, aber ich denke, eine "Beschreibung" (eine kurze Notiz über den Zweck des Zweigs) wäre schön.

Answer 1

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

Der Befehl definiert eine globale Option alias.about als Shell-Ausdruck. Ausführen von git about <branch> in einem Repository wird die Beschreibung des Zweigs angezeigt, wenn sie gesetzt ist.

Answer 2

Hier ist ein git alias die es Ihnen ermöglicht, Beschreibungen des aktuellen Zweigs sowohl zu setzen als auch zu lesen:

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

Verwendung/Beispiele:

(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

Besonderen Dank an @Felicio für die Antwort, die mich auf den Weg gebracht hat.

Answer 3

Hier ist eine mögliche Implementierung des git branches Kommando, auf das Greg Hewgill anspielte:

#!/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";
}

Answer 4

Angenommen, Sie möchten einen Zweig erstellen

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

Answer 5

Sie können Kommentare an Tags anhängen:

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

Konventionell können Sie Tags haben, die sich auf die Namen Ihrer Zweige beziehen, oder Sie können tag -f verwenden, um ein kommentiertes Tag an den Anfang Ihrer Themenzweige zu stellen.