Mô tả chi nhánh trong Git

Có cách nào trong Git để có một 'mô tả' cho các chi nhánh không?

Trong khi tôi cố gắng sử dụng tên mô tả, làm việc một lúc trên một nhánh đôi khi làm giảm trí nhớ của tôi về lý do tại sao tôi thực hiện một số nhánh chủ đề khác. Tôi cố gắng sử dụng tên mô tả cho các chi nhánh, nhưng tôi nghĩ rằng một "mô tả" (ghi chú ngắn về mục đích của chi nhánh) sẽ tốt.

Git 1.7.9 hỗ trợ này. Từ ghi chú phát hành 1.7.9 :

 * "git nhánh --edit-description" có thể được sử dụng để thêm văn bản mô tả
   để giải thích những gì một nhánh chủ đề là về.

Bạn có thể thấy tính năng đó được giới thiệu trở lại vào tháng 9 năm 2011, với các cam kết 6f9a332 , 739453a3 , b7200e8 :

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

--edit-description::

Mở trình soạn thảo và chỉnh sửa văn bản để giải thích chi nhánh dùng để làm gì, được sử dụng bởi nhiều lệnh khác (ví dụ request-pull).

Lưu ý rằng nó sẽ không hoạt động cho một chi nhánh CHÍNH.

Mô tả đó được sử dụng bởi tập lệnh request-pull: xem commit c016814783 , nhưng cũng có git merge --log.

request-pull là một tập lệnh được sử dụng để tóm tắt các thay đổi giữa hai lần cam kết với đầu ra tiêu chuẩn và bao gồm URL đã cho trong tóm tắt được tạo.

[Từ @AchalDave] Thật không may, bạn không thể đẩy các mô tả vì chúng được lưu trữ trong cấu hình của bạn, khiến nó trở nên vô dụng vì mục đích ghi lại các nhánh trong một nhóm.

Nếu bạn làm kết thúc bằng cách sử dụng README, tạo một bí danh git sửa đổi git checkoutđể README của bạn sẽ được hiển thị mỗi khi bạn chuyển đổi các chi nhánh.

Ví dụ: thêm phần này vào ~ / .gitconfig, trong [bí danh]

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

Sau này, bạn có thể chạy git cor <branch_name>để chuyển nhánh và hiển thị README của nhánh bạn đang chuyển sang.

Sử dụng git branch --edit-descriptionđể đặt hoặc chỉnh sửa mô tả chi nhánh.

Đây là một hàm shell để hiển thị các nhánh tương tự git branchnhưng có thêm phần mô tả.

# 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
}

Đây là những gì gbtrông giống như, được hiển thị ở đây dưới dạng văn bản trong trường hợp hình ảnh rots:

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

Và như một hình ảnh, vì vậy bạn có thể thấy màu sắc:

Đề READMExuất của Chris J có thể hoạt động, miễn là nó được thiết lập với trình điều khiển hợp nhất tùy chỉnh được xác định trong a.gitattribute .
Bằng cách đó, phiên bản địa phương của READMEluôn được bảo tồn trong quá trình hợp nhất.

"Mô tả" cho các nhánh cũng được gọi là "nhận xét" được liên kết với dữ liệu meta đó và nó không được hỗ trợ.

Ít nhất, với một READMEtệp, bạn có thể, đối với bất kỳ chi nhánh nào, hãy thực hiện:

$ git show myBranch:README

Nếu README của bạn nằm trong thư mục gốc của REPO, nó sẽ hoạt động từ bất kỳ đường dẫn nào, vì đường dẫn được sử dụng git showlà một đường dẫn tuyệt đối từ thư mục trên cùng của repo đã nói.

Có hai gợi ý phổ biến ở đây:

1. git branch --edit-description: Chúng tôi không thích điều này bởi vì bạn không thể đẩy nó. Có lẽ tôi có thể nhớ những chi nhánh tôi tạo ra, nhưng nhóm của tôi chắc chắn không thể.
2. READMEtập tin pr. chi nhánh. Đây là một nỗi đau trong quá trình hợp nhất: Siêu dễ hợp nhất các xung đột và chúng tôi sẽ kéo vào READMEtừ các chi nhánh khi chúng tôi hợp nhất các nhánh tính năng. Khác biệt giữa các nhánh cũng là một nỗi đau.

Chúng tôi đã quyết định tạo ra một branches-readmechi nhánh mồ côi . Các nhánh mồ côi là các nhánh có lịch sử riêng biệt - bạn có thể biết chúng từ gh-pagescác nhánh của Github . Chi nhánh mồ côi này chứa một READMEtập tin duy nhất . Nó có nội dung như:

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

Nó có khả năng đẩy và hợp nhất thân thiện. Xem READMEtừ bất kỳ chi nhánh với:

git show branches-readme:README

Nhược điểm là bạn cần kiểm tra chi nhánh mồ côi kỳ lạ khi bạn muốn cập nhật READMEvà READMEkhông tự động cập nhật khi các chi nhánh được đổi tên, đến hoặc đi. Điều đó là tốt cho chúng tôi, mặc dù.

Làm như thế:

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

Similary, các thành viên trong nhóm riêng lẻ cũng có thể tạo các branches-$usernhánh mồ côi của riêng họ mô tả các nhánh riêng của họ nếu họ muốn, miễn là họ không đẩy họ vào nhóm.

Với công cụ tiếp theo, điều này cũng có thể được tích hợp với đầu ra của git branch. Cuối cùng, có lẽ một README.yamltập tin có thể được xem xét thay vì đơn giản README.

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

Lệnh sẽ định nghĩa một tùy chọn toàn cục alias.aboutlà biểu thức shell. Chạy git about <branch>trong một kho lưu trữ sẽ hiển thị mô tả của chi nhánh nếu được đặt.

Đây là một triển khai có thể của git brancheslệnh Greg Hewgill đã ám chỉ:

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

Đây là một git aliascho phép bạn đặt và đọc mô tả trên nhánh hiện tại:

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

Cách sử dụng / ví dụ:

(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

Đặc biệt cảm ơn @Felermo vì câu trả lời đã giúp tôi bắt đầu.

Bạn có thể đính kèm ý kiến ​​vào thẻ:

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

Theo quy ước, bạn có thể có các thẻ liên quan đến tên chi nhánh của mình hoặc bạn có thể sử dụng thẻ -f để giữ thẻ nhận xét ở đầu chi nhánh chủ đề của mình.

Nói rằng bạn muốn tạo một chi nhánh

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

Tôi khá chắc chắn rằng tính năng này hiện không được hỗ trợ. Tôi nghĩ rằng cách tốt nhất của bạn là tạo một tệp văn bản mô tả, về cơ bản là README, trong nhánh có thông tin mà bạn muốn.

Câu trả lời được chọn có vẻ như quá mức cần thiết với tôi. Tôi muốn được xu hướng duy trì cho mỗi chi nhánh tập tin mô tả đó là một điều khiển nguồn tập tin bình thường, chẳng hạn master.txt, dev.txtvv và nếu có một số khó sử dụng hoặc chi nhánh Tôi muốn tạo ra một hệ thống phân cấp để tổ chức tốt hơn nó.

Chỉ dùng:

git config branch.<branch name>.description

Để cung cấp tín dụng khi tín dụng đáo hạn: https://glebbahmutov.com/blog/git-branches-with-descrip/

Sử dụng

git branch --list -v

để hiển thị một nhánh ngược dòng:

git branch --list -vv

Thêm vào -rđể hiển thị từ xa chỉ hoặc -ađể hiển thị điều khiển từ xa và địa phương.