Merge pull request #66 from manics/noref

If no github ref is found optionally return a default tag

README.md

@@ -29,6 +29,9 @@ The GitHub action's only output is named `tags` and is a JSON formatted list. Se
 ## Optional input parameters
 
 - `prefix`: A string that each returned tag should be prefixed with, for example to tag a Docker container set this to `user/repository:`.
+- `defaultTag`: If the tag output would be empty return this tag instead.
+  This can be useful for running a workflow in pull requests where no suitable git references are present.
+  `prefix` is _not_ automatically added.
 
 ## Example workflow
 

__tests__/main.test.js

@@ -16,6 +16,7 @@ test("No other tags", async () => {
     "owner",
     "repo",
     "refs/tags/0.0.1",
+    "",
     ""
   );
   expect(tags).toEqual(["0.0.1", "0.0", "0", "latest"]);
@@ -38,6 +39,7 @@ test("Is the latest tag", async () => {
     "owner",
     "repo",
     "refs/tags/2.0.0",
+    "",
     ""
   );
   expect(tags).toEqual(["2.0.0", "2.0", "2", "latest"]);
@@ -63,6 +65,7 @@ test("Not the latest major tag", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0", "1.1", "1"]);
@@ -91,6 +94,7 @@ test("Not the latest minor tag", async () => {
     "owner",
     "repo",
     "refs/tags/2.2.1",
+    "",
     ""
   );
   expect(tags).toEqual(["2.2.1", "2.2"]);
@@ -116,6 +120,7 @@ test("Includes pre-releases", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-2",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-2", "1.1.0", "1.1", "1"]);
@@ -138,6 +143,7 @@ test("Includes pre-releases jump one", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-2",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-2", "1.1.0", "1.1", "1", "latest"]);
@@ -157,6 +163,7 @@ test("Includes pre-releases no jump", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-1",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1", "latest"]);
@@ -182,6 +189,7 @@ test("Handling of an outdated build number", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-1",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1"]);
@@ -207,6 +215,7 @@ test("Handling build number comparisons numerically", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-10",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-10", "1.1.0", "1.1", "1"]);
@@ -219,28 +228,41 @@ test("Unsupported prerelease tag", async () => {
     "owner",
     "repo",
     "refs/tags/2.0.0-rc1",
+    "",
     ""
   );
   expect(tags).toEqual(["2.0.0-rc1"]);
 });
 
 test("Not a tag", async () => {
   await expect(
-    calculateTags("TOKEN", "owner", "repo", "something/else", "")
+    calculateTags("TOKEN", "owner", "repo", "something/else", "", "")
   ).rejects.toEqual(new Error("Not a tag or branch: something/else"));
 });
 
 test("Invalid semver tag", async () => {
   await expect(
-    calculateTags("TOKEN", "owner", "repo", "refs/tags/v1", "")
+    calculateTags("TOKEN", "owner", "repo", "refs/tags/v1", "", "")
   ).rejects.toEqual(new Error("Invalid semver tag: v1"));
 });
 
 test("No ref", async () => {
-  const tags = await calculateTags("TOKEN", "owner", "repo", null, "");
+  const tags = await calculateTags("TOKEN", "owner", "repo", null, "", "");
   expect(tags).toEqual([]);
 });
 
+test("No ref use default", async () => {
+  const tags = await calculateTags(
+    "TOKEN",
+    "owner",
+    "repo",
+    null,
+    "",
+    "default-tag"
+  );
+  expect(tags).toEqual(["default-tag"]);
+});
+
 test("Prefix", async () => {
   const scope = nock("https://api.github.com")
     .get("/repos/owner/repo/tags")
@@ -254,7 +276,8 @@ test("Prefix", async () => {
     "owner",
     "repo",
     "refs/tags/0.0.1",
-    "prefix:"
+    "prefix:",
+    ""
   );
   expect(tags).toEqual([
     "prefix:0.0.1",
@@ -271,6 +294,7 @@ test("Branch", async () => {
     "owner",
     "repo",
     "refs/heads/main",
+    "",
     ""
   );
   expect(tags).toEqual(["main"]);
@@ -295,6 +319,7 @@ test("Includes pre-releases one", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-1",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1", "latest"]);
@@ -323,6 +348,7 @@ test("Includes pre-releases one with new tag", async () => {
     "owner",
     "repo",
     "refs/tags/1.1.0-1",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1"]);

action.yml

@@ -3,12 +3,17 @@ description: Calculate major and minor semver tags, e.g. for tagging containers
 author: Simon Li
 inputs:
   githubToken:
-    required: true
+    required: false
     description: GitHub token
+    default: ""
   prefix:
     required: false
     description: Prefix each tag with this string, e.g. "docker/repository:"
     default: ""
+  defaultTag:
+    required: false
+    description: If the tag output would be empty return this tag instead
+    default: ""
 outputs:
   tags:
     description: List of calculated tags

src/index.js

@@ -20,7 +20,7 @@ function equalMajorMinorPatch(a, b) {
   return a.major == b.major && a.minor == b.minor && a.patch == b.patch;
 }
 
-async function calculateTags(token, owner, repo, ref, prefix) {
+async function calculateTags(token, owner, repo, ref, prefix, defaultTag) {
   // About the parameters:
   // - token is used to authenticate against the GitHub API that in turn is used
   //   to list tags for github.com/<owner>/<repo>.
@@ -32,6 +32,9 @@ async function calculateTags(token, owner, repo, ref, prefix) {
 
   if (!ref) {
     core.debug("No ref");
+    if (defaultTag) {
+      return [defaultTag];
+    }
     return [];
   }
   if (ref.startsWith("refs/heads/")) {
@@ -121,14 +124,16 @@ async function run() {
     // githubToken: ${{ secrets.GITHUB_TOKEN }}
     const githubToken = core.getInput("githubToken");
     const prefix = core.getInput("prefix");
+    const defaultTag = core.getInput("defaultTag");
 
     core.debug(JSON.stringify(github.context));
     const allTags = await calculateTags(
       githubToken,
       github.context.payload.repository.owner.login,
       github.context.payload.repository.name,
       github.context.payload.ref,
-      prefix
+      prefix,
+      defaultTag
     );
 
     core.info(allTags);