คำอธิบายสาขาใน Git

มีวิธีใน Git ที่จะมี 'คำอธิบาย' สำหรับสาขาหรือไม่?

ในขณะที่ฉันพยายามใช้ชื่อที่เป็นคำอธิบายการทำงานเป็นระยะเวลาหนึ่งในสาขาเดียวบางครั้งทำให้ความจำของฉันแย่ลงเพราะเหตุใดฉันจึงสร้างหัวข้อย่อยบางหัวข้อ ฉันพยายามใช้ชื่อที่เป็นคำอธิบายสำหรับสาขา แต่ฉันคิดว่า 'คำอธิบาย' (โน้ตสั้น ๆ เกี่ยวกับวัตถุประสงค์ของสาขา) จะดี

Git 1.7.9 รองรับสิ่งนี้ จากบันทึกประจำรุ่น 1.7.9 :

 * "git branch --edit-description" สามารถใช้เพื่อเพิ่มข้อความอธิบาย
   เพื่ออธิบายว่าหัวข้อเกี่ยวกับสาขาใด

คุณจะเห็นคุณลักษณะนั้นเปิดตัวในเดือนกันยายน 2554 โดยมีข้อผูกพัน6f9a332 , 739453a3 , b7200e8 :

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

--edit-description::

เปิดโปรแกรมแก้ไขและแก้ไขข้อความเพื่ออธิบายว่าสาขานั้นมีไว้เพื่อใช้งานโดยคำสั่งอื่น ๆ (เช่นrequest-pull)

โปรดทราบว่าจะไม่ทำงานกับสาขา HEAD เดี่ยว

คำอธิบายนั้นถูกใช้โดยสคริปต์ request-pull: ดูการกระทำ c016814783แต่ก็เช่นgit merge --logกัน

request-pull เป็นสคริปต์ที่ใช้ในการสรุปการเปลี่ยนแปลงระหว่างสองคอมมิทกับเอาต์พุตมาตรฐานและรวม URL ที่กำหนดไว้ในข้อมูลสรุปที่สร้างขึ้น

[จาก @AchalDave] น่าเสียดายที่คุณไม่สามารถผลักดันคำอธิบายได้เนื่องจากมันถูกเก็บไว้ในรูปแบบของคุณทำให้มันไร้ประโยชน์สำหรับการบันทึกสาขาในทีม

หากคุณทำจะสิ้นสุดการใช้ README ให้สร้างGit นามแฝงแก้ไขgit checkoutเพื่อให้ README ของคุณจะปรากฏทุกครั้งที่คุณสลับสาขา

ตัวอย่างเช่นเพิ่มใน ~ / .gitconfig ภายใต้[alias]

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.

และในฐานะที่เป็นรูปภาพคุณจึงสามารถดูสีต่างๆได้:

READMEแนะนำโดยคริสเจสามารถทำงานให้มันมีการติดตั้งด้วยโปรแกรมควบคุมการผสานที่กำหนดเองที่กำหนดไว้ใน .gitattribute
ด้วยวิธีนี้รุ่นท้องถิ่นของREADMEจะถูกเก็บรักษาไว้เสมอในระหว่างการรวม

"คำอธิบาย" สำหรับสาขานั้นทราบว่าเป็น "ความคิดเห็น" ที่เชื่อมโยงกับข้อมูลเมตานั้นและไม่ได้รับการสนับสนุน

อย่างน้อยREADMEคุณสามารถทำได้สำหรับสาขาใด ๆ ด้วย:

$ git show myBranch:README

หาก README ของคุณอยู่ที่ไดเรกทอรีรากของ REPO ของคุณมันจะทำงานจากเส้นทางใด ๆ เนื่องจากเส้นทางที่ใช้โดยgit showเป็นเส้นทางที่แน่นอนจากไดเรกทอรีบนสุดของ repo ดังกล่าว

มีสองคำแนะนำยอดนิยมที่นี่:

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.yamlREADME

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

คำสั่งจะกำหนดตัวเลือกระดับโลกalias.aboutเป็นนิพจน์เชลล์ ทำงานgit about <branch>ในพื้นที่เก็บข้อมูลจะแสดงคำอธิบายของสาขาถ้าตั้งค่า

นี่คือการปฏิบัติที่เป็นไปได้ของgit branchesคำสั่ง Greg 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

ตามแบบแผนคุณอาจมีแท็กที่เกี่ยวข้องกับชื่อสาขาของคุณหรือคุณสามารถใช้ tag -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เพื่อแสดงรีโมตและโลคัล