createAnnotationTag

Create a new tag in the repository from an object without creating a reference.

The message will not be cleaned up.

The tag name will be checked for validity. You must avoid the characters '~', '^', ':', ' \ ', '?', '[', and '*', and the sequences ".." and " @ {" which have special meaning to revparse.

Signature

class Repository {
  createAnnotationTag(
    name: string,
    target: GitObject,
    message: string,
    options?: CreateAnnotationTagOptions | null | undefined,
  ): string;
}

Parameters

• namerequired · string
  

  The name of tag.

• targetrequired · GitObject
  

  Git object to pointed by this tag.

• messagerequired · string
  

  The message of tag.

• optionsnull | CreateAnnotationTagOptions
  

  Options for creating the tag.

  • taggerSignaturePayload
    

    Signature for tagger. If not provided, default signature of repository will be used. If there is no default signature set for the repository, an error will occur.

    • emailrequired · string
      

      Email on the signature.

    • namerequired · string
      

      Name on the signature.

    • timeOptionsSignatureTimeOptions
      
      • offsetnumber
        

        Timezone offset, in minutes

      • timestamprequired · number
        

        Time in seconds, from epoch

Returns

• string
  

  Tag OID(SHA1) which created.