Merge pull request #89 from manics/branchRegex

Add branchRegex for validating/excluding branch names

README.md

@@ -32,6 +32,7 @@ The GitHub action's only output is named `tags` and is a JSON formatted list. Se
 - `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.
+- `branchRegex`: If a branch name does not match this regex return `defaultTag` or empty instead.
 
 ## Output parameters
 
@@ -64,6 +65,7 @@ jobs:
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
           prefix: "my-username/my-image-name:"
+          branchRegex: "^[^/]+$"
 
       # https://github.com/docker/login-action
       - name: Login to DockerHub

__tests__/main.test.js

@@ -17,6 +17,7 @@ test("No other tags", async () => {
     "repo",
     "refs/tags/0.0.1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["0.0.1", "0.0", "0", "latest"]);
@@ -40,6 +41,7 @@ test("Is the latest tag", async () => {
     "repo",
     "refs/tags/2.0.0",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["2.0.0", "2.0", "2", "latest"]);
@@ -66,6 +68,7 @@ test("Not the latest major tag", async () => {
     "repo",
     "refs/tags/1.1.0",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0", "1.1", "1"]);
@@ -95,6 +98,7 @@ test("Not the latest minor tag", async () => {
     "repo",
     "refs/tags/2.2.1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["2.2.1", "2.2"]);
@@ -121,6 +125,7 @@ test("Includes pre-releases", async () => {
     "repo",
     "refs/tags/1.1.0-2",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-2", "1.1.0", "1.1", "1"]);
@@ -144,6 +149,7 @@ test("Includes pre-releases jump one", async () => {
     "repo",
     "refs/tags/1.1.0-2",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-2", "1.1.0", "1.1", "1", "latest"]);
@@ -164,6 +170,7 @@ test("Includes pre-releases no jump", async () => {
     "repo",
     "refs/tags/1.1.0-1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1", "latest"]);
@@ -190,6 +197,7 @@ test("Handling of an outdated build number", async () => {
     "repo",
     "refs/tags/1.1.0-1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1"]);
@@ -216,6 +224,7 @@ test("Handling build number comparisons numerically", async () => {
     "repo",
     "refs/tags/1.1.0-10",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-10", "1.1.0", "1.1", "1"]);
@@ -229,6 +238,7 @@ test("Unsupported prerelease tag", async () => {
     "repo",
     "refs/tags/2.0.0-rc1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["2.0.0-rc1"]);
@@ -258,7 +268,8 @@ test("No ref use default", async () => {
     "repo",
     null,
     "",
-    "default-tag"
+    "default-tag",
+    ""
   );
   expect(tags).toEqual(["default-tag"]);
 });
@@ -277,6 +288,7 @@ test("Prefix", async () => {
     "repo",
     "refs/tags/0.0.1",
     "prefix:",
+    "",
     ""
   );
   expect(tags).toEqual([
@@ -295,11 +307,38 @@ test("Branch", async () => {
     "repo",
     "refs/heads/main",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["main"]);
 });
 
+test("Branch doesn't match regex", async () => {
+  const tags = await calculateTags(
+    "TOKEN",
+    "owner",
+    "repo",
+    "refs/heads/branch/with/slash",
+    "",
+    "",
+    "^[^/]+$"
+  );
+  expect(tags).toEqual([]);
+});
+
+test("Branch doesn't match regex with default", async () => {
+  const tags = await calculateTags(
+    "TOKEN",
+    "owner",
+    "repo",
+    "refs/heads/branch/with/slash",
+    "prefix-ignored-by-defaultTag",
+    "default-tag",
+    "^[^/]+$"
+  );
+  expect(tags).toEqual(["default-tag"]);
+});
+
 test("Includes pre-releases one", async () => {
   const scope = nock("https://api.github.com")
     .get("/repos/owner/repo/tags")
@@ -320,6 +359,7 @@ test("Includes pre-releases one", async () => {
     "repo",
     "refs/tags/1.1.0-1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1", "latest"]);
@@ -349,6 +389,7 @@ test("Includes pre-releases one with new tag", async () => {
     "repo",
     "refs/tags/1.1.0-1",
     "",
+    "",
     ""
   );
   expect(tags).toEqual(["1.1.0-1", "1.1.0", "1.1", "1"]);

action.yml

@@ -23,6 +23,11 @@ inputs:
       This can be useful for running a workflow in pull requests where no suitable git references are present.
       `prefix` is _not_ automatically added.
     default: ""
+  branchRegex:
+    required: false
+    description: |-
+      If a branch name does not match this regex return `defaultTag` or empty instead.
+    default: "^.+$"
 outputs:
   tags:
     description: A JSON formatted list of calculated tags.

src/index.js

@@ -20,7 +20,20 @@ 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, defaultTag) {
+function checkAgainstRegex(name, regexAllowed) {
+  const re = new RegExp(regexAllowed);
+  return re.test(name);
+}
+
+async function calculateTags(
+  token,
+  owner,
+  repo,
+  ref,
+  prefix,
+  defaultTag,
+  regexAllowed
+) {
   // 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>.
@@ -40,6 +53,12 @@ async function calculateTags(token, owner, repo, ref, prefix, defaultTag) {
   if (ref.startsWith("refs/heads/")) {
     const branch = ref.substring(11);
     core.debug(`Branch: ${branch}`);
+    if (!checkAgainstRegex(branch, regexAllowed)) {
+      if (defaultTag) {
+        return [defaultTag];
+      }
+      return [];
+    }
     return [`${prefix}${branch}`];
   }
   if (!ref.startsWith("refs/tags/")) {
@@ -125,6 +144,7 @@ async function run() {
     const githubToken = core.getInput("githubToken");
     const prefix = core.getInput("prefix");
     const defaultTag = core.getInput("defaultTag");
+    const branchRegex = core.getInput("branchRegex");
 
     core.debug(JSON.stringify(github.context));
     const allTags = await calculateTags(
@@ -133,7 +153,8 @@ async function run() {
       github.context.payload.repository.name,
       github.context.payload.ref,
       prefix,
-      defaultTag
+      defaultTag,
+      branchRegex
     );
 
     core.info(allTags);