Skip to content

Instantly share code, notes, and snippets.

@topheman
Created June 29, 2015 17:39
Show Gist options
  • Save topheman/ec8cde7c54e24a785e52 to your computer and use it in GitHub Desktop.
Save topheman/ec8cde7c54e24a785e52 to your computer and use it in GitHub Desktop.
Git notes cheat sheet

#Git notes

Warning : Support for isplay of git notes has been dropped by github : https://github.com/blog/707-git-notes-display

Resource : https://vimeo.com/34273537

##Add

git notes add
git notes add -m "my note"

##Namespacing

Default namespace is commits

Use git notes --ref COMMAND

Examples:

git notes --ref jenkins add "build pass"
git notes --ref jenkins show HEAD
git log --show-notes=jenkins
git log --show-notes="*"

--show-notes="*" : Quotes are necessary so that * will be passed to git, not evalueted by the command line

##Push

Like tags, notes aren't pushed by default.

git push origin refs/notes/commits
git push origin "refs/notes/*"

##Fetch

Notes aren't fetched by default.

git fetch origin refs/notes/commits:refs/notes/commits
git fetch origin "refs/notes/*:refs/notes/*"

To fetch notes by default : vi .git/config

#edit this part

[remote "origin"]
  fetch = +refs/heads/*:refs/remotes/origin/*

#to become

[remote "origin"]
  fetch = +refs/heads/*:refs/remotes/origin/*
  fetch = +refs/notes/*:refs/notes/*
@cmcqueen
Copy link

cmcqueen commented Jun 4, 2024

@CervEdin What is the variant you/they want?

@CervEdin
Copy link

CervEdin commented Jul 8, 2024

@CervEdin What is the variant you/they want?

@cmcqueen it's a while since I tried this and wrote the comment, also the Git refspec is non-trivial but I was to guess, I believe this causes fetch/pull to only consider notes and not other refs (branches).

Could be wrong/missremembering

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment