v5.0.0 (#7)

* add send_command input

* add client-ssm

* add SSMClient

* add sendCommand

* add send_command to tests

* Update dist file

* add deps

* add inputs/outputs to readme

* update action table

* update README

* update README

* update README

* update action.yml

* update readme.ts

* update send_command description

* update README

* add waitForCommand

* update deps

* update inputs

* use snake_case for inputs

* update inputs

* update inputs

* fix conditionals

* refactor getEnvironments

* refactor updateListenerRules

* refactor updateListenerRules

* update readme

* update command status logging

* filter empty envs

* use vitest

* add ansi-styles

* delete jest.config.js

* update tsconfig.json

* remove dotenv

* update setDescribeEventsInterval params

* use esm import

* rename main.blue_green.test.ts

* import fs

* refactor inputs.test.ts

* add TestAlbStack

* rename shared_alb.test.ts

* update deps

* update TestAlbStack

* fix shared_alb test

* update shared_alb test

* update getCnamePrefix

* update tsconfig

* update tsconfig

* Update dist file

* set default DisableIMDSv1 to true in order to use launch template

* Update dist file

* use named exports

* Update dist file

* update deps

* update shared_alb test

* refactor: simplify environment checks and error handling in updateListenerRules

* docs: clarify descriptions for CNAME inputs and update_listener_rules in action.yml

* update readme

* update .env.example

* update .gitignore

* mv main.blue_green test

* Update dist file

* update version

---------

Co-authored-by: tmshkr <[email protected]>

Author: tmshkr

.env.example

@@ -9,19 +9,24 @@ INPUT_DEPLOY="true"
 INPUT_DISABLE_TERMINATION_PROTECTION="false"
 INPUT_ENABLE_TERMINATION_PROTECTION="false"
 INPUT_GREEN_ENV="my-green-env"
+INPUT_MINIMUM_HEALTH_COLOR="Green"
 INPUT_OPTION_SETTINGS=
 INPUT_PLATFORM_BRANCH_NAME="Docker running on 64bit Amazon Linux 2023"
-INPUT_PRODUCTION_CNAME="my-production-cname"
-INPUT_PROMOTE="true"
-INPUT_SOURCE_BUNDLE=
+INPUT_PRODUCTION_CNAME="my-prod-cname"
+INPUT_SEND_COMMAND="echo 'it works!' >>test.txt"
+# INPUT_SINGLE_ENV_CNAME="single-env-cname"
+# INPUT_SINGLE_ENV="my-env"
+INPUT_SOURCE_BUNDLE="test/bundle.zip"
 INPUT_STAGING_CNAME="my-staging-cname"
+INPUT_SWAP_CNAMES="false"
 INPUT_TEMPLATE_NAME=
-INPUT_TERMINATE_UNHEALTHY_ENVIRONMENT="true"
+INPUT_TERMINATE_UNHEALTHY_ENVIRONMENT="false"
 INPUT_UPDATE_ENVIRONMENT="true"
 INPUT_UPDATE_LISTENER_RULES="false"
+INPUT_USE_DEFAULT_OPTION_SETTINGS="true"
 INPUT_VERSION_DESCRIPTION=
-INPUT_VERSION_LABEL=
+INPUT_VERSION_LABEL="test-version"
+INPUT_WAIT_FOR_COMMAND="true"
 INPUT_WAIT_FOR_DEPLOYMENT="true"
 INPUT_WAIT_FOR_ENVIRONMENT="true"
 INPUT_WAIT_FOR_TERMINATION="true"
-INPUT_USE_DEFAULT_OPTION_SETTINGS="true"

.gitignore

@@ -136,4 +136,5 @@ build
 !.elasticbeanstalk/*.global.yml
 
 bundle*
-.DS_Store
+.DS_Store
+cdk.out

README.md

@@ -14,7 +14,7 @@ inputs:
     description: "AWS session token for using temporary credentials. May instead be specified via the AWS_SESSION_TOKEN environment variable."
   blue_env:
     description: "Name of the blue environment."
-    required: true
+    needs: [green_env, production_cname, staging_cname]
   create_environment:
     description: "Whether to create a new environment during deployment if the target environment doesn't exist."
     default: "true"
@@ -29,7 +29,7 @@ inputs:
     default: "false"
   green_env:
     description: "Name of the green environment."
-    required: true
+    needs: [blue_env, production_cname, staging_cname]
   minimum_health_color:
     description: "Minimum health color (Green, Yellow, Red, or Grey) required for the target environment to be considered healthy."
     default: "Green"
@@ -38,26 +38,43 @@ inputs:
   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."
   production_cname:
-    description: "CNAME prefix for the domain that serves production traffic."
-    required: true
+    description: "CNAME prefix for the domain that serves production traffic when performing a blue/green deployment."
+    needs: [blue_env, green_env, staging_cname]
+  send_command:
+    description: "Command to send to the target environment after (optional) deployment. Specify a shell script or series of commands to run. Useful for running tasks related to deployment, such as swapping environment variables before promoting an environment to production."
+  single_env:
+    description: "Name of a single environment to deploy. If specified, the blue/green environments and production/staging CNAMEs must not be provided."
+    needs: [single_env_cname]
+  single_env_cname:
+    description: "CNAME prefix to use for a single-environment deployment."
+    needs: [single_env]
   source_bundle:
     description: "Path to the source bundle to deploy. If not specified, the sample application will be used."
   staging_cname:
-    description: "CNAME prefix for the staging environment."
-    required: true
+    description: "CNAME prefix of the staging environment for a blue/green deployment."
+    needs: [blue_env, green_env, production_cname]
   swap_cnames:
     description: "Whether to swap the CNAMEs of the blue and green environments."
     default: "false"
   template_name:
     description: "Name of an Elastic Beanstalk configuration template to use when creating a new environment."
   terminate_unhealthy_environment:
     description: "Whether to terminate an unhealthy target environment. If set to false, the action will fail if the target environment is unhealthy."
-    default: "true"
+    default: "false"
   update_environment:
     description: "Whether to update an existing environment during deployment."
     default: "true"
   update_listener_rules:
-    description: "When set to true, the action will update any elbv2 listener rules on the environments' SharedLoadBalancer tagged with a `bluegreenbeanstalk:target_cname` key, whose value is equal to the staging or production CNAME prefix, so that it forwards to the corresponding target group. The action will also remove any target group from the listener before terminating the environment. The port of the process may be specified by another tag with the key `bluegreenbeanstalk:target_port` whose value is the port number. If no such tag is found, the default port of 80 will be used."
+    description: |
+      When set to true, the action will update any elbv2 listener rules on the environments' SharedLoadBalancer tagged with a `bluegreenbeanstalk:target_cname` key, whose value is equal to an environment's CNAME prefix, so that it forwards to the corresponding target group.
+
+      For example, you can tag a listener rule that matches the host `my-domain.com` with a tag containing `bluegreenbeanstalk:target_cname` as its key and `my-prod-cname` as its value, and the action will update the listener rule to point to the same target group as the environment with the CNAME `my-prod-cname`.
+
+      The listener rules are updated after the CNAMEs are swapped, so this keeps the listener rules in sync with the CNAMEs.
+
+      The port of the process may be specified by another tag with the key `bluegreenbeanstalk:target_port` whose value is the port number. If no such tag is found, the default port of 80 will be used.
+
+      If you'd only like to update the listener rules for a certain CNAME, you can set this input to the CNAME prefix you'd like to update.
     default: "false"
   use_default_option_settings:
     description: "Whether to use default option settings when creating a new environment."
@@ -66,6 +83,9 @@ inputs:
     description: "Description to use for the new application version."
   version_label:
     description: "Version label to use for the new application version."
+  wait_for_command:
+    description: "Whether to wait for the send_command execution to complete."
+    default: "true"
   wait_for_deployment:
     description: "Whether to wait for the deployment to complete."
     default: "true"