Add image-override input to aws-codebuild-run-build action

This commit allows user to start build with image override by passing
image-override parameter to the action with desired ECR image URI.

Author: ronakfof

README.md

@@ -22,6 +22,9 @@ The only required input is `project-name`.
    that CodeBuild requires.
    By default, the action uses the buildspec file location
    that you configured in the CodeBuild project.
+1. **image-override** (optional) :
+   The name of an image for this build that overrides the one specified
+   in the build project.
 1. **env-vars-for-codebuild** (optional) :
    A comma-separated list of the names of environment variables
    that the action passes from GitHub Actions to CodeBuild.
@@ -162,6 +165,7 @@ this will overwrite them.
   with:
     project-name: CodeBuildProjectName
     buildspec-override: path/to/buildspec.yaml
+    image-override: ecr-image-uri
     env-vars-for-codebuild: |
       custom,
       requester,

action.yml

@@ -10,6 +10,9 @@ inputs:
   buildspec-override:
     description: 'Buildspec Override'
     required: false
+  image-override:
+    description: 'The name of an image for this build that overrides the one specified in the build project.'
+    required: false
   env-vars-for-codebuild:
     description: 'Comma separated list of environment variables to send to CodeBuild'
     required: false

code-build.js

@@ -169,6 +169,9 @@ function githubInputs() {
   const buildspecOverride =
     core.getInput("buildspec-override", { required: false }) || undefined;
 
+  const imageOverride = 
+    core.getInput("image-override", { required: false }) || undefined;
+
   const envPassthrough = core
     .getInput("env-vars-for-codebuild", { required: false })
     .split(",")
@@ -181,6 +184,7 @@ function githubInputs() {
     repo,
     sourceVersion,
     buildspecOverride,
+    imageOverride,
     envPassthrough,
   };
 }
@@ -192,6 +196,7 @@ function inputs2Parameters(inputs) {
     repo,
     sourceVersion,
     buildspecOverride,
+    imageOverride,
     envPassthrough = [],
   } = inputs;
 
@@ -212,6 +217,7 @@ function inputs2Parameters(inputs) {
     sourceTypeOverride,
     sourceLocationOverride,
     buildspecOverride,
+    imageOverride,
     environmentVariablesOverride,
   };
 }

dist/index.js

@@ -295409,7 +295409,8 @@ module.exports = /******/ (function (modules, runtime) {
         assert(sourceVersion, "No source version could be evaluated.");
         const buildspecOverride =
           core.getInput("buildspec-override", { required: false }) || undefined;
-
+        const imageOverride =
+          core.getInput("image-override", { required: false }) || undefined;
         const envPassthrough = core
           .getInput("env-vars-for-codebuild", { required: false })
           .split(",")
@@ -295422,6 +295423,7 @@ module.exports = /******/ (function (modules, runtime) {
           repo,
           sourceVersion,
           buildspecOverride,
+          imageOverride,
           envPassthrough,
         };
       }
@@ -295433,6 +295435,7 @@ module.exports = /******/ (function (modules, runtime) {
           repo,
           sourceVersion,
           buildspecOverride,
+          imageOverride,
           envPassthrough = [],
         } = inputs;
 
@@ -295453,6 +295456,7 @@ module.exports = /******/ (function (modules, runtime) {
           sourceTypeOverride,
           sourceLocationOverride,
           buildspecOverride,
+          imageOverride,
           environmentVariablesOverride,
         };
       }

local.js

@@ -8,7 +8,7 @@ const cb = require("./code-build");
 const assert = require("assert");
 const yargs = require("yargs");
 
-const { projectName, buildspecOverride, envPassthrough, remote } = yargs
+const { projectName, buildspecOverride, imageOverride, envPassthrough, remote } = yargs
   .option("project-name", {
     alias: "p",
     describe: "AWS CodeBuild Project Name",
@@ -20,6 +20,11 @@ const { projectName, buildspecOverride, envPassthrough, remote } = yargs
     describe: "Path to buildspec file",
     type: "string",
   })
+  .option("image-override", {
+    alias: "i",
+    describe: "The name of an image for this build that overrides the one specified in the build project.",
+    type: "string",
+  })
   .option("env-vars-for-codebuild", {
     alias: "e",
     describe: "List of environment variables to send to CodeBuild",
@@ -39,6 +44,7 @@ const params = cb.inputs2Parameters({
   ...githubInfo(remote),
   sourceVersion: BRANCH_NAME,
   buildspecOverride,
+  imageOverride,
   envPassthrough,
 });
 

test/code-build-test.js

@@ -71,6 +71,7 @@ describe("githubInputs", () => {
     expect(test)
       .to.haveOwnProperty("buildspecOverride")
       .and.to.equal(undefined);
+    expect(test).to.haveOwnProperty("imageOverride").and.to.equal(undefined);
     expect(test).to.haveOwnProperty("envPassthrough").and.to.deep.equal([]);
   });
 
@@ -120,6 +121,7 @@ describe("githubInputs", () => {
     expect(test)
       .to.haveOwnProperty("buildspecOverride")
       .and.to.equal(undefined);
+    expect(test).to.haveOwnProperty("imageOverride").and.to.equal(undefined);
     expect(test).to.haveOwnProperty("envPassthrough").and.to.deep.equal([]);
   });
 
@@ -173,6 +175,7 @@ describe("inputs2Parameters", () => {
     expect(test)
       .to.haveOwnProperty("buildspecOverride")
       .and.to.equal(undefined);
+    expect(test).to.haveOwnProperty("imageOverride").and.to.equal(undefined);
 
     // I send everything that starts 'GITHUB_'
     expect(test)