Merge pull request #102 from marcus-bcl/master

Support Disabling Source Type Override Parameters, including Source Version

Author: taoyong-ty

README.md

@@ -31,6 +31,9 @@ The only required input is `project-name`.
 1. **image-override** (optional) :
    The name of an image for this build that overrides the one specified
    in the build project.
+1. **disable-source-override** (optional) :
+   Set to `true` if you want to disable providing `sourceVersion`,
+   `sourceTypeOverride` and `sourceLocationOverride` to CodeBuild.
 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.
@@ -247,7 +250,7 @@ In the call to StartBuild, we pass in all
 `GITHUB_` [environment variables][github environment variables] in the GitHub Actions environment,
 plus any environment variables that you specified in the `env-passthrough` input value.
 
-Regardless of the project configuration in CodeBuild or GitHub Actions,
+By default, regardless of the project configuration in CodeBuild or GitHub Actions,
 we always pass the following parameters and values to CodeBuild in the StartBuild API call.
 
 | CodeBuild value          | GitHub value                           |
@@ -256,6 +259,8 @@ we always pass the following parameters and values to CodeBuild in the StartBuil
 | `sourceTypeOverride`     | The string `'GITHUB'`                  |
 | `sourceLocationOverride` | The `HTTPS` git url for `context.repo` |
 
+If you want to disable sending the parameters `sourceVersion`, `sourceTypeOverride` and `sourceLocationOverride` you can use `disable-source-override` input.
+
 ### What we did not do
 
 This action intentionally does not let you specify every option

action.yml

@@ -28,7 +28,9 @@ inputs:
   update-back-off:
     description: 'Base back-off time for the update calls for API if rate-limiting is encountered'
     required: false
-
+  disable-source-override:
+    description: 'Set to `true` if you want do disable source repo override'
+    required: false
 outputs:
   aws-build-id:
     description: 'The AWS CodeBuild Build ID for this build.'

code-build.js

@@ -165,6 +165,8 @@ async function waitForBuildEndTime(
 
 function githubInputs() {
   const projectName = core.getInput("project-name", { required: true });
+  const disableSourceOverride =
+    core.getInput("disable-source-override", { required: false }) === "true";
   const { owner, repo } = github.context.repo;
   const { payload } = github.context;
   // The github.context.sha is evaluated on import.
@@ -220,6 +222,7 @@ function githubInputs() {
     envPassthrough,
     updateInterval,
     updateBackOff,
+    disableSourceOverride,
   };
 }
 
@@ -234,10 +237,16 @@ function inputs2Parameters(inputs) {
     environmentTypeOverride,
     imageOverride,
     envPassthrough = [],
+    disableSourceOverride,
   } = inputs;
 
-  const sourceTypeOverride = "GITHUB";
-  const sourceLocationOverride = `https://github.com/${owner}/${repo}.git`;
+  const sourceOverride = !disableSourceOverride
+    ? {
+        sourceVersion: sourceVersion,
+        sourceTypeOverride: "GITHUB",
+        sourceLocationOverride: `https://github.com/${owner}/${repo}.git`,
+      }
+    : {};
 
   const environmentVariablesOverride = Object.entries(process.env)
     .filter(
@@ -249,14 +258,13 @@ function inputs2Parameters(inputs) {
   // This way the GitHub events can manage the builds.
   return {
     projectName,
-    sourceVersion,
-    sourceTypeOverride,
-    sourceLocationOverride,
+    ...sourceOverride,
     buildspecOverride,
     computeTypeOverride,
     environmentTypeOverride,
     imageOverride,
     environmentVariablesOverride,
+    disableSourceOverride,
   };
 }