Merge pull request #1 from tmshkr/dev

v3

Author: tmshkr

.github/workflows/build.yml

@@ -10,7 +10,6 @@ on:
 
 jobs:
   build:
-    name: Build and save dist file
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -21,8 +20,10 @@ jobs:
         run: |
           npm ci
           npm run build
-      - uses: EndBug/add-and-commit@v9
-        with:
-          default_author: github_actions
-          add: dist
-          push: true
+      - name: Save dist file
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          git add dist
+          git commit -m "Update dist file" || true
+          git push

.github/workflows/latest.yml

@@ -0,0 +1,18 @@
+name: Update latest tag
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  tag:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Update latest tag
+        run: |
+          git push origin :refs/tags/latest
+          git tag latest
+          git push origin --tags

README.md

@@ -65,13 +65,14 @@ jobs:
       - name: Generate source bundle
         run: echo ${{ github.ref_name }} > ENVIRONMENT && zip -r bundle.zip . -x '*.git*'
       - name: Deploy
-        uses: tmshkr/blue-green-beanstalk@v2.1
+        uses: tmshkr/blue-green-beanstalk@latest
         with:
           app_name: "test-app"
           aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws_region: ${{ vars.AWS_REGION }}
           aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           blue_env: "my-blue-env"
+          deploy: true
           green_env: "my-green-env"
           platform_branch_name: "Docker running on 64bit Amazon Linux 2023"
           production_cname: "blue-green-beanstalk-prod" # must be available

action.yml

@@ -1,78 +1,68 @@
 name: "Blue/Green Beanstalk"
-description: "GitHub Action to automate deployment to Blue/Green environments on AWS Elastic Beanstalk."
+description: "Deploy to blue/green environments on AWS Elastic Beanstalk."
 inputs:
   app_name:
     description: "Name of the Elastic Beanstalk application. If it doesn't exist, it will be created."
     required: true
   aws_access_key_id:
     description: "AWS Access Key ID. May instead be specified via the AWS_ACCESS_KEY_ID environment variable."
-    required: false
   aws_region:
     description: "AWS region. May instead be specified via the AWS_REGION environment variable."
-    required: false
   aws_secret_access_key:
     description: "AWS Secret Access Key. May instead be specified via the AWS_SECRET_ACCESS_KEY environment variable."
-    required: false
   aws_session_token:
     description: "AWS session token for using temporary credentials. May instead be specified via the AWS_SESSION_TOKEN environment variable."
-    required: false
   blue_env:
-    description: "Name of the Blue environment."
+    description: "Name of the blue environment."
     required: true
   deploy:
     description: "Whether to deploy the new application version to the target environment."
-    required: true
-    default: true
+    default: false
   green_env:
-    description: "Name of the Green environment."
+    description: "Name of the green environment."
     required: true
   option_settings:
     description: "Path to a JSON file of option settings to use when creating a new environment. When using custom option settings, the default option settings will be ignored, but the SharedLoadBalancer will still be provided when using the `shared_alb` strategy."
-    required: false
   platform_branch_name:
     description: "Name of the platform branch to use. When creating a new environment, it will be launched with the latest version of the specified platform branch. To see the list of available platform branches, run the `aws elasticbeanstalk list-platform-branches` command."
-    required: true
+  prep:
+    description: "When prep is set to true, the action will exit if the target environment is healthy, or create a new environment if it is not healthy. This is useful for preparing the target environment, e.g. with the sample application, before deploying a new application version in a later step."
+    default: false
   ports:
     description: "Comma-separated list of ALB listener ports for use with the `shared_alb` strategy. When using the action to create an ALB, HTTP listeners will be created for each port. To enable HTTPS, port 443 must be configured on the ALB with ACM. When using an existing ALB, the action will update each specified port's default listener rule to point to the target environment if `promote` is set to true."
-    required: true
     default: "80"
   production_cname:
     description: "CNAME prefix for the domain that serves production traffic. Only required for the `swap_cnames` strategy."
-    required: false
   promote:
     description: "Whether to promote the target environment to production. When using the `swap_cnames` strategy, the action will swap the CNAMEs of the blue and green environments to redirect production traffic to the target environment. When using the `shared_alb` strategy, the action will update the shared Application Load Balancer's default listener rule to point to the target environment, replacing the other environment."
-    required: true
-    default: true
+    default: false
   staging_cname:
     description: "CNAME prefix for the staging environment when using the `swap_cnames` strategy."
-    required: false
   source_bundle:
     description: "Path to the source bundle to deploy. If not specified, the sample application will be used."
-    required: false
   strategy:
     description: "Deployment strategy to use: `swap_cnames` or `shared_alb`. See the `promote` input description for more details."
-    required: true
     default: "swap_cnames"
   template_name:
     description: "Name of an Elastic Beanstalk configuration template to use when creating a new environment."
-    required: false
   terminate_unhealthy_environment:
     description: "Whether to terminate an unhealthy target environment. If set to false, the action will exit with an error when the target environment is unhealthy."
-    required: true
     default: true
   version_description:
     description: "Description to use for the new application version."
-    required: false
   version_label:
     description: "Version label to use for the new application version."
-    required: false
+  wait_for_deployment:
+    description: "Whether to wait for the deployment or environment creation to complete."
+    default: true
   wait_for_environment:
-    description: "Whether to wait for an environment to update or terminate. If set to false, the action will exit with a non-error code during deployment, or exit with an error when the environment is terminating or otherwise not ready."
-    required: true
+    description: "Whether to wait for the target environment to be ready before deployment."
+    default: true
+  wait_for_termination:
+    description: "Whether to wait for an environment to be terminated."
     default: true
   use_default_option_settings:
     description: "Whether to use default option settings when creating a new environment."
-    required: true
     default: true
 outputs:
   target_env_cname:

dist/index.js

@@ -210905,7 +210905,9 @@ function getCredentials() {
 }
 const awsConfig = {
     credentials: getCredentials(),
-    region: process.env.INPUT_AWS_REGION || process.env.AWS_REGION,
+    region: process.env.INPUT_AWS_REGION ||
+        process.env.AWS_REGION ||
+        process.env.AWS_DEFAULT_REGION,
 };
 const asClient = new client_auto_scaling_dist_cjs.AutoScalingClient(awsConfig);
 const ebClient = new dist_cjs.ElasticBeanstalkClient(awsConfig);
@@ -210929,6 +210931,8 @@ const fs = __nccwpck_require__(57147);
 
 function getApplicationVersion(inputs) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!inputs.versionLabel)
+            return null;
         const { ApplicationVersions } = yield ebClient.send(new dist_cjs.DescribeApplicationVersionsCommand({
             ApplicationName: inputs.appName,
             VersionLabels: [inputs.versionLabel],
@@ -210937,14 +210941,11 @@ function getApplicationVersion(inputs) {
             console.log(`Application version ${inputs.versionLabel} already exists.`);
             return ApplicationVersions[0];
         }
-        const newVersion = yield createApplicationVersion(inputs);
-        return newVersion;
+        return yield createApplicationVersion(inputs);
     });
 }
 function createApplicationVersion(inputs) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!inputs.versionLabel)
-            return null;
         let SourceBundle;
         if (inputs.sourceBundle) {
             const { S3Bucket } = yield ebClient.send(new dist_cjs.CreateStorageLocationCommand({}));
@@ -210987,20 +210988,21 @@ const inputs_fs = __nccwpck_require__(57147);
 function getInputs() {
     const inputs = {
         appName: core.getInput("app_name", { required: true }),
-        awsRegion: core.getInput("aws_region") || process.env.AWS_REGION,
+        awsRegion: core.getInput("aws_region") ||
+            process.env.AWS_REGION ||
+            process.env.AWS_DEFAULT_REGION,
         blueEnv: core.getInput("blue_env", { required: true }),
         deploy: core.getBooleanInput("deploy", { required: true }),
         greenEnv: core.getInput("green_env", { required: true }),
         optionSettings: core.getInput("option_settings")
             ? JSON.parse(inputs_fs.readFileSync(core.getInput("option_settings")))
             : undefined,
-        platformBranchName: core.getInput("platform_branch_name", {
-            required: true,
-        }),
+        platformBranchName: core.getInput("platform_branch_name"),
         ports: core.getInput("ports", { required: true })
             .split(",")
             .map((str) => Number(str))
             .filter((num) => Boolean(num)),
+        prep: core.getBooleanInput("prep"),
         productionCNAME: core.getInput("production_cname") || undefined,
         promote: core.getBooleanInput("promote", { required: true }),
         sourceBundle: core.getInput("source_bundle") || undefined,
@@ -211010,9 +211012,15 @@ function getInputs() {
         terminateUnhealthyEnvironment: core.getBooleanInput("terminate_unhealthy_environment", { required: true }),
         versionDescription: core.getInput("version_description") || undefined,
         versionLabel: core.getInput("version_label") || undefined,
+        waitForDeployment: core.getBooleanInput("wait_for_deployment", {
+            required: true,
+        }),
         waitForEnvironment: core.getBooleanInput("wait_for_environment", {
             required: true,
         }),
+        waitForTermination: core.getBooleanInput("wait_for_termination", {
+            required: true,
+        }),
         useDefaultOptionSettings: core.getBooleanInput("use_default_option_settings", {
             required: true,
         }),
@@ -211048,6 +211056,9 @@ function checkInputs(inputs) {
         if (!inputs.productionCNAME) {
             throw new Error("production_cname is required when using the swap_cnames strategy");
         }
+        if (!inputs.stagingCNAME) {
+            throw new Error("staging_cname is required when using the swap_cnames strategy");
+        }
         if (inputs.productionCNAME === inputs.stagingCNAME) {
             throw new Error("production_cname and staging_cname must be different");
         }
@@ -211060,6 +211071,11 @@ function checkInputs(inputs) {
             throw new Error("the shared_alb strategy requires a port to be provided");
         }
     }
+    if (inputs.optionSettings) {
+        if (!Array.isArray(inputs.optionSettings)) {
+            throw new Error("option_settings must be an array");
+        }
+    }
 }
 
 ;// CONCATENATED MODULE: ./src/getEnvironments.ts
@@ -211098,9 +211114,10 @@ function getEnvironments(inputs) {
                 };
             case DeploymentStrategy.SwapCNAMEs:
                 const prodDomain = `${inputs.productionCNAME}.${inputs.awsRegion}.elasticbeanstalk.com`;
+                const stagingDomain = `${inputs.stagingCNAME}.${inputs.awsRegion}.elasticbeanstalk.com`;
                 return {
                     prodEnv: Environments.find(({ CNAME }) => CNAME === prodDomain),
-                    stagingEnv: Environments.find(({ CNAME }) => CNAME !== prodDomain),
+                    stagingEnv: Environments.find(({ CNAME }) => CNAME === stagingDomain),
                 };
             default:
                 throw new Error(`Unknown strategy: ${inputs.strategy}`);
@@ -211189,7 +211206,7 @@ function setDescribeEventsInterval(environmentId, startTime = new Date()) {
             startTime = Events[0].EventDate;
             for (const e of Events.reverse()) {
                 console.log(`${printUTCTime(e.EventDate)} ${e.Severity} ${e.EnvironmentName}: ${e.Message}`);
-                if (e.Message === "Failed to launch environment.") {
+                if (e.Severity === "ERROR") {
                     throw new Error(e.Message);
                 }
             }
@@ -211227,13 +211244,13 @@ function terminateEnvironment(inputs, environmentId, environmentName) {
         yield ebClient.send(new dist_cjs.TerminateEnvironmentCommand({
             EnvironmentId: environmentId,
         }));
-        if (inputs.waitForEnvironment) {
+        if (inputs.waitForTermination) {
             const interval = setDescribeEventsInterval(environmentId, startTime);
             yield (0,dist_cjs.waitUntilEnvironmentTerminated)({ client: ebClient, maxWaitTime: 60 * 10, minDelay: 5, maxDelay: 30 }, { EnvironmentIds: [environmentId] });
             clearInterval(interval);
         }
         else
-            throw new Error("Target environment is terminating and wait_for_environment is set to false.");
+            throw new Error("Target environment is terminating and wait_for_termination is set to false.");
     });
 }
 
@@ -211261,21 +211278,21 @@ function getTargetEnv(inputs) {
             return null;
         }
         if (targetEnv.Status === "Terminating") {
-            if (inputs.waitForEnvironment) {
+            if (inputs.waitForTermination) {
                 console.log("Target environment is terminating. Waiting...");
                 const interval = setDescribeEventsInterval(targetEnv.EnvironmentId);
                 yield (0,dist_cjs.waitUntilEnvironmentTerminated)({ client: ebClient, maxWaitTime: 60 * 10, minDelay: 5, maxDelay: 30 }, { EnvironmentIds: [targetEnv.EnvironmentId] });
                 clearInterval(interval);
                 return null;
             }
             else
-                throw new Error("Target environment is terminating and wait_for_environment is set to false.");
+                throw new Error("Target environment is terminating and wait_for_termination is set to false.");
         }
         else if (targetEnv.Status !== "Ready") {
             if (inputs.waitForEnvironment) {
                 console.log("Target environment is not ready. Waiting...");
                 const interval = setDescribeEventsInterval(targetEnv.EnvironmentId);
-                yield (0,dist_cjs.waitUntilEnvironmentExists)({ client: ebClient, maxWaitTime: 60 * 10, minDelay: 5, maxDelay: 30 }, { EnvironmentIds: [targetEnv.EnvironmentId] });
+                yield (0,dist_cjs.waitUntilEnvironmentUpdated)({ client: ebClient, maxWaitTime: 60 * 10, minDelay: 5, maxDelay: 30 }, { EnvironmentIds: [targetEnv.EnvironmentId] });
                 clearInterval(interval);
                 return getTargetEnv(inputs);
             }
@@ -211378,6 +211395,9 @@ var createEnvironment_awaiter = (undefined && undefined.__awaiter) || function (
 
 function getPlatformArn(platformBranchName) {
     return createEnvironment_awaiter(this, void 0, void 0, function* () {
+        if (!platformBranchName) {
+            throw new Error("platform_branch_name must be provided when creating a new environment");
+        }
         const { PlatformSummaryList } = yield ebClient.send(new dist_cjs.ListPlatformVersionsCommand({
             Filters: [
                 {
@@ -211407,7 +211427,7 @@ function createEnvironment(inputs, applicationVersion) {
                 throw new Error(`Invalid strategy: ${inputs.strategy}`);
         }
         console.log(`Creating environment ${newEnv.EnvironmentId} ${newEnv.EnvironmentName}...`);
-        if (!inputs.waitForEnvironment) {
+        if (!inputs.waitForDeployment) {
             return newEnv;
         }
         const interval = setDescribeEventsInterval(newEnv.EnvironmentId, startTime);
@@ -211538,9 +211558,11 @@ function deploy(inputs, targetEnv, applicationVersion) {
         const startTime = new Date();
         yield ebClient.send(new dist_cjs.UpdateEnvironmentCommand({
             EnvironmentId: targetEnv.EnvironmentId,
+            OptionSettings: inputs.optionSettings,
+            TemplateName: inputs.templateName,
             VersionLabel: applicationVersion === null || applicationVersion === void 0 ? void 0 : applicationVersion.VersionLabel,
         }));
-        if (!inputs.waitForEnvironment) {
+        if (!inputs.waitForDeployment) {
             return;
         }
         const interval = setDescribeEventsInterval(targetEnv.EnvironmentId, startTime);
@@ -211679,6 +211701,13 @@ function main(inputs) {
         try {
             const applicationVersion = yield getApplicationVersion(inputs);
             let targetEnv = yield getTargetEnv(inputs);
+            if (inputs.prep) {
+                if (!targetEnv) {
+                    targetEnv = yield createEnvironment(inputs, applicationVersion);
+                }
+                yield setOutputs(targetEnv);
+                return;
+            }
             if (inputs.deploy) {
                 if (targetEnv) {
                     yield deploy(inputs, targetEnv, applicationVersion);
@@ -211688,6 +211717,7 @@ function main(inputs) {
                 }
             }
             if (inputs.promote) {
+                console.log(`Promoting environment ${targetEnv.EnvironmentName} to production...`);
                 if (!targetEnv) {
                     throw new Error("No target environment to promote");
                 }
@@ -211698,6 +211728,9 @@ function main(inputs) {
                     if (Environments[0].Health !== "Green") {
                         throw new Error(`Environment ${targetEnv.EnvironmentName} is not healthy. Aborting promotion.`);
                     }
+                    if (Environments[0].Status !== "Ready") {
+                        throw new Error(`Environment ${targetEnv.EnvironmentName} is not ready. Aborting promotion.`);
+                    }
                 });
                 switch (inputs.strategy) {
                     case DeploymentStrategy.SharedALB:

src/clients.ts

@@ -22,7 +22,10 @@ function getCredentials() {
 
 const awsConfig = {
   credentials: getCredentials(),
-  region: process.env.INPUT_AWS_REGION || process.env.AWS_REGION,
+  region:
+    process.env.INPUT_AWS_REGION ||
+    process.env.AWS_REGION ||
+    process.env.AWS_DEFAULT_REGION,
 };
 
 export const asClient = new AutoScalingClient(awsConfig);