Add deprecation warning

Author: julianmesa-gitkraken

lib/tag.js

@@ -1,3 +1,4 @@
+var util = require("util");
 var NodeGit = require("../");
 var LookupWrapper = NodeGit.Utils.lookupWrapper;
 var Tag = NodeGit.Tag;
@@ -49,6 +50,10 @@ Tag.createBuffer = function(repo, tagName, target, tagger, message) {
     });
 };
 
+const deprecatedCreateWithSignatureHelper = util.deprecate(function(repo, oidTarget) {
+  return repo.getCommit(oidTarget);
+}, "Tag.createWithSignature target should be a Git Object, not Oid");
+
 /**
  * @async
  * @param {Repository} repo
@@ -70,37 +75,68 @@ Tag.createWithSignature = function(
   force,
   signingCallback
 ) {
-  let tagBuffer;
-  return Tag.createBuffer(repo, tagName, target.id(), tagger, message)
-    .then((tagBufferResult) => {
-      tagBuffer = tagBufferResult;
-      return signingCallback(tagBuffer);
-    })
-    .then(({ code, signedData }) => {
-      switch (code) {
-        case NodeGit.Error.CODE.OK: {
-          const normalizedEnding = signedData.endsWith("\n") ? "" : "\n";
-          const signedTagString = tagBuffer + signedData + normalizedEnding;
-          return Tag.createFromBuffer(repo, signedTagString, force);
-        }
-        case NodeGit.Error.CODE.PASSTHROUGH:
-          return Tag.create(
-            repo,
-            tagName,
-            target,
-            tagger,
-            message,
-            force
-          );
-        default: {
-          const error = new Error(
-            `Tag.createWithSignature threw with error code ${code}`
-          );
-          error.errno = code;
-          throw error;
+
+  const createTag = function(repo,
+    tagName,
+    target,
+    tagger,
+    message,
+    force,
+    signingCallback) {
+    let tagBuffer;
+
+    return Tag.createBuffer(repo, tagName, target.id(), tagger, message)
+      .then((tagBufferResult) => {
+        tagBuffer = tagBufferResult;
+        return signingCallback(tagBuffer);
+      })
+      .then(({ code, signedData }) => {
+        switch (code) {
+          case NodeGit.Error.CODE.OK: {
+            const normalizedEnding = signedData.endsWith("\n") ? "" : "\n";
+            const signedTagString = tagBuffer + signedData + normalizedEnding;
+            return Tag.createFromBuffer(repo, signedTagString, force);
+          }
+          case NodeGit.Error.CODE.PASSTHROUGH:
+            return Tag.create(
+              repo,
+              tagName,
+              target,
+              tagger,
+              message,
+              force
+            );
+          default: {
+            const error = new Error(
+              `Tag.createWithSignature threw with error code ${code}`
+            );
+            error.errno = code;
+            throw error;
+          }
         }
-      }
+      });
+  };
+
+  if (!target.id) {
+    deprecatedCreateWithSignatureHelper(repo, target).then((targetOid) => {
+      return createTag(repo,
+        tagName,
+        targetOid,
+        tagger,
+        message,
+        force,
+        signingCallback);
     });
+  } else {
+    return createTag(repo,
+      tagName,
+      target,
+      tagger,
+      message,
+      force,
+      signingCallback);
+  }
+
 };
 
 /**