git - pushing branch descriptions to remote

git

Solution

Considering the description is stored in the config file (here, the local one, within your Git repo), then, no, branch descriptions aren't pushed.

Config files are not pushed (ever). See "Is it possible to clone git config from remote location?"

Simple text files are, though, as my initial answer for branch description recommended at the time.

Branch descriptions are all about helping make an helpful message for publishing. Not for copying that message over the other repos which won't have to publish the same information/commits.

Using `branch.$name.description` as the configuration key, give users a place to write about what the purpose of the branch is and things like that, so that various subsystems, e.g. "`push -s`", "`request-pull`", and "`format-patch --cover-letter`", can later be taught to use this information.

Update 2020 (8 years later):

philb mentions in the comments the issue `gitgitgadget/git` 438 about "Branch descriptions should be versionable". philb adds:

If this is ever implemented, branch descriptions would be stored in refs and could then be pushed to a remote.

Problem

Once a week we have integration meetings where we review code in branches not merged in to master. As a starting point we use this to list open branches `git branch -a --no-merged master` We name our branches after ticket numbers so it tough to see what we are really looking at. I get back `BUG_1231231` `BUG_1412434` `FEATURE_1231231` `FEATURE_1232244` I know I can add and view descriptions by running `git branch --edit-description BUG_1231231` `git config branch.BUG_1231231` The issue is these descriptions seemed to be stored in the config of my local repository. Can these descriptions be pushed to the remote?

Original source

Related problems