Skip to content

createLightweightTag

Create a new lightweight tag pointing at a target object.

A new direct reference will be created pointing to this target object.

Signature

ts
class Repository {
  createLightweightTag(
    name: string,
    target: GitObject,
    options?: CreateLightweightTagOptions,
  ): string;
}

Parameters

  • namerequired · string

    The name of tag.

  • targetrequired · GitObject

    Git object to pointed by this tag.

  • optionsnull | CreateLightweightTagOptions

    Options for creating the tag.

    • forceboolean

      If force is true and a reference already exists with the given name, it'll be replaced.

Returns

  • string

    Tag OID(SHA1) which created.

Released under the MIT License.