module Agate::Notes

Overview

Git notes operations.

Defined in:

agate/notes.cr

Class Method Summary

• .create(repo : Repository, oid : OID, author : Agate::Signature, committer : Agate::Signature, message : String, notes_ref : String | Nil = nil, force : Bool = false) : OID

  Creates a note on the given object.

• .default_ref(repo : Repository) : String

  Returns the default notes reference name.

• .read(repo : Repository, oid : OID, notes_ref : String | Nil = nil) : Note

  Reads a note attached to the given object.

• .read?(repo : Repository, oid : OID, notes_ref : String | Nil = nil) : Note | Nil

  Reads a note, returning nil if none exists.

• .remove(repo : Repository, oid : OID, author : Agate::Signature, committer : Agate::Signature, notes_ref : String | Nil = nil) : Nil

  Removes a note from the given object.

Class Method Detail