Git'teki şube açıklamaları

Git'te şubeler için 'açıklama' almanın bir yolu var mı?

Açıklayıcı adları kullanmaya çalışırken, bir süre tek bir dalda çalışmak bazen diğer konu dallarından bazılarını neden yaptığımın hafızasını hafifletir. Dallar için açıklayıcı isimler kullanmaya çalışıyorum, ama bence bir 'açıklama' (dalın amacı hakkında kısa not) iyi olurdu.

Git 1.7.9 bunu desteklemektedir. Gönderen 1.7.9 sürüm notları :

 * "git branch --edit-description" açıklayıcı metin eklemek için kullanılabilir
   bir konu dalının ne hakkında olduğunu açıklamak.

6f9a332 , 739453a3 , b7200e8 taahhütleriyle Eylül 2011'de tanıtılan bu özelliği görebilirsiniz :

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

--edit-description::

Bir düzenleyici açın ve diğer çeşitli komutlar tarafından kullanılmak üzere dalın ne için olduğunu açıklamak için metni düzenleyin (örn. request-pull).

Ayrılmış bir HEAD dalı için çalışmayacağını unutmayın.

Bu açıklama komut istemi çekme tarafından kullanılır: bkz . Command c016814783 , aynı zamanda git merge --log.

request-pull standart çıktıya iki taahhüt arasındaki değişiklikleri özetlemek için kullanılan bir komut dosyasıdır ve verilen URL'yi oluşturulan özete ekler.

[@AchalDave'den] Maalesef açıklamaları yapılandırmanızda saklandıkları için zorlayamazsınız.

Eğer varsa do README kullanarak sonuna, bir oluşturmak git takma değiştirerek git checkoutsizin README dalları geçiş her zaman görüntülenecek şekilde.

Örneğin, bunu [diğer ad] altındaki ~ / .gitconfig dosyasına ekleyin

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

Bundan sonra, git cor <branch_name>dalı değiştirmek ve geçiş yaptığınız dalın README'sini görüntülemek için çalışabilirsiniz .

git branch --edit-descriptionŞube açıklamasını ayarlamak veya düzenlemek için kullanın .

Dallara benzer git branchancak açıklamaları eklenmiş olan bir kabuk işlevi .

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

İşte budur gbgörüntü çürüyene durumda metin olarak burada gösterildiği gibi görünüyor:

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

Ve bir görüntü olarak, renkleri görebilirsiniz:

READMEÖnerdiği Chris J , çalışabilir bir ile kurulum olması koşuluyla bir de tanımlanan özel birleştirme sürücü.gitattribute .
Bu şekilde, birleştirme sırasında yerel sürümü READMEher zaman korunur.

Şubeler için "açıklama", bu meta verilerle ilişkilendirilmiş bir "yorum" olarak da bilinir ve desteklenmez.

En azından, bir READMEdosyayla, herhangi bir dal için şunları yapabilirsiniz:

$ git show myBranch:README

README'niz REPO'nuzun kök dizinindeyse, tarafından kullanılan yol, git showbelirtilen deponun üst dizininden mutlak bir yol olduğu için herhangi bir yoldan çalışacaktır .

Burada iki popüler öneri var:

1. git branch --edit-description: Bunu sevmiyoruz çünkü itemezsiniz. Belki oluşturduğum dalların ne yaptığını hatırlayabilirim, ama ekibim kesinlikle yapamaz.
2. READMEdosya pr. dalı. Bu birleşme sırasındaki bir acıdır: Çatışmaları birleştirmeye eğilimlidir ve READMEözellik dallarını birleştirdiğimizde dallardan çekiliriz. Dallar arasındaki farklar da bir acıdır.

Bir yetim branches-readmedalı oluşturmaya karar verdik . Yetim şubeleri kendi ayrı geçmişlerine sahip şubelerdir - bunları Github gh-pagesşubelerinden tanıyabilirsiniz . Bu yetim dalı tek bir READMEdosya içeriyor . İçeriği:

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

İtme ve birleştirme dostudur. İle READMEherhangi bir şubeden görüntüle :

git show branches-readme:README

Dezavantajları, güncellemek istediğinizde garip yetim şubesini kontrol etmeniz READMEve READMEşubeler yeniden adlandırıldıkça, geldikçe veya gittikçe otomatik olarak güncellenmez. Yine de bu bizim için iyi.

Gibi yapın:

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

Benzer şekilde, bireysel ekip üyeleri branches-$useristedikleri taktirde kendi özel dallarını tanımlayan kendi yetim şubelerini de oluşturabilirler, ancak onları takıma itmedikleri sürece.

Daha fazla takım ile bu çıktı ile de entegre edilebilir git branch. Bu amaçla, belki bir README.yamldosya yerine bir dosya düşünülebilir README.

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

Command, global seçeneği alias.aboutkabuk ifadesi olarak tanımlar . git about <branch>Bir havuzda çalıştırıldığında , ayarlanmışsa dalın açıklaması görüntülenir.

İşte git branchesGreg Hewgill'in bahsettiği komutun olası bir uygulaması :

#!/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 aliasGeçerli dalda açıklamaları ayarlamanızı ve okumanızı sağlayan bir a :

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

Kullanım / örnekler:

(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

Beni başlatan cevap için @Felicio'ya özel teşekkürler.

Etiketlere yorum ekleyebilirsiniz:

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

Kural olarak, şube adlarınızla ilgili etiketleriniz olabilir veya yorumlanan bir etiketi konu dallarınızın başında tutmak için -f etiketini kullanabilirsiniz.

Diyelim ki bir şube oluşturmak istiyorsunuz

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

Bu özelliğin şu anda desteklenmediğinden eminim. En iyi bahsinizin, istediğiniz bir bilgiye sahip olan şubede bir README açıklaması metni dosyası oluşturmak olduğunu düşünüyorum.

Seçilen cevap benim için aşırı dolu gibi görünüyor. Ben normal bir kaynak kontrollü dosya, diyelim bir şube başına açıklama dosyası korumak için eğimli olurdu master.txt, dev.txtvb ve kullanılması zor bir numara veya dalları olup olmadığını daha iyi bir hiyerarşi oluşturmak organize ediyorum.

Sadece kullan:

git config branch.<branch name>.description

Kredinin vadesi geldiğinde kredi vermek için: https://glebbahmutov.com/blog/git-branches-with-description/

kullanım

git branch --list -v

yukarı yönlü bir şube göstermek için:

git branch --list -vv

-rYalnızca uzaktan kumandaları göstermek veya -auzaktan kumandaları ve yerelleri göstermek için ekleyin .