build: who lotta cleanup and organization

Author: stieg

.dependabot/config.yml

@@ -1,9 +1,9 @@
 version: 1
 update_configs:
-  - package_manager: "javascript"
-    directory: "/"
-    update_schedule: "monthly"
+  - package_manager: 'javascript'
+    directory: '/'
+    update_schedule: 'monthly'
     automerged_updates:
       - match:
-          dependency_type: "all"
-          update_type: "semver:minor"
+          dependency_type: 'all'
+          update_type: 'semver:minor'

.eslintignore

@@ -0,0 +1,9 @@
+.DS_Store
+.github
+.vscode
+coverage/
+dist/
+node_modules/
+package-lock.json
+package.json
+typings.d.ts

.eslintrc.js

@@ -0,0 +1,44 @@
+module.exports = {
+  env: {
+    es6: true,
+    'jest/globals': true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    // 'plugin:jest/all',
+    'plugin:prettier/recommended',
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  plugins: ['jest', 'prettier'],
+  root: true,
+  rules: {
+    // 'import/order': [
+    //   'error',
+    //   {
+    //     alphabetize: {
+    //       caseInsensitive: false,
+    //       order: 'asc',
+    //     },
+    //     groups: [
+    //       'builtin',
+    //       'external',
+    //       ['internal', 'parent', 'sibling', 'index'],
+    //     ],
+    //     'newlines-between': 'always',
+    //   },
+    // ],
+    'max-params': ['error', 5],
+    'no-console': ['error', { allow: ['warn', 'error'] }],
+    'no-param-reassign': 'error',
+    'no-var': 'error',
+    'prefer-arrow-callback': ['error', { allowNamedFunctions: true }],
+    'sort-keys': 'error',
+  },
+};

.eslintrc.json

@@ -1,6 +1,5 @@
-*Issue #, if available:*
-
-*Description of changes:*
+_Issue #, if available:_
 
+_Description of changes:_
 
 By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,52 @@
 on:
-  [pull_request]
+  pull_request:
+  push:
+    branches:
+      - f/**
+      - p/**
+      - renovate/**
 
-name: Check
+name: CI
 
 jobs:
-  check:
+  lint:
     name: Run Unit Tests
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Run tests
-      run: |
-        npm ci
-        npm test
+      - name: Fetch all branches and tags
+        run: git fetch --prune --unshallow
+
+      - name: NPM Cache
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
+
+      - name: NPM Install
+        run: npm ci
+
+      # - name: Commitlint
+      #   if: ${{ github.event_name == 'pull_request' }}
+      #   run: npx commitlint --from origin/${{ github.base_ref }} --to origin/${{ github.head_ref }}
+
+      - name: Lint
+        run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: NPM Cache
+        uses: actions/cache@v1
+        with:
+          key: ${{ runner.os }}-npm-cache-${{ hashFiles('**/package-lock.json') }}
+          path: ~/.npm
+
+      - name: NPM Install
+        run: npm ci
+
+      - name: Test
+        run: npm run test

.github/workflows/check.yml

@@ -10,18 +10,19 @@ jobs:
     name: Package distribution file
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-      with:
-        ref: master
-    - name: Package
-      run: |
-        npm ci
-        npm test
-        npm run package
-    - name: Commit
-      run: |
-        git config --global user.name "GitHub Actions"
-        git add dist/
-        git commit -m "chore: Update dist" || echo "No changes to commit"
-        git push origin HEAD:master
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: master
+      - name: Package
+        run: |
+          npm ci
+          npm lint
+          npm test
+          npm run package
+      - name: Commit
+        run: |
+          git config --global user.name "GitHub Actions"
+          git add dist/
+          git commit -m "chore: Update dist" || echo "No changes to commit"
+          git push origin HEAD:master

.github/workflows/package.yml

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## [1.0.0]
 
+Initial release of the action. Branched from
+https://github.com/aws-actions/amazon-ecs-deploy-task-definition.git
+and modified to support pushing to ecs scheduled tasks instead of ECS
+services.
 
 ### Features
 
-### Bug Fixes
+- Adds in support for ESC scheduled tasks.
+- Adds in tests to validat logic.
+- Removes service deployment code.

CHANGELOG.md

@@ -1,7 +1,5 @@
 MIT License
 
-Copyright 2019 Amazon.com, Inc. or its affiliates.
-
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

LICENSE

@@ -1,31 +1,32 @@
-## Amazon ECS "Deploy Task Definition" Action for GitHub Actions
+## ECS "Deploy Task Definition to Scheduled Tasks" Action for GitHub Actions
 
-Registers an Amazon ECS task definition and deploys it to an ECS service.
+Registers an Amazon ECS task definition and deploys it to scheduled tasks in a given ECS cluster
 
 **Table of Contents**
 
 <!-- toc -->
 
+- [Acknowledgements](#acknowledgements)
 - [Usage](#usage)
 - [Credentials and Region](#credentials-and-region)
 - [Permissions](#permissions)
-- [AWS CodeDeploy Support](#aws-codedeploy-support)
 - [Troubleshooting](#troubleshooting)
 - [License Summary](#license-summary)
-- [Security Disclosures](#security-disclosures)
 
 <!-- tocstop -->
 
+## Acknowledgements
+This project is a fork of the [amazon-ecs-deploy-task-definition](https://github.com/aws-actions/amazon-ecs-deploy-task-definition) that has been modified and re-tooled to work with ECS scheduled tasks.
+
 ## Usage
+The action assumes you have already setup 1 or more tasks to run as a scheduled task in the ECS environment. This action will update _all_ of the tasks who cluster and task ARN (without version) match existing scheduled actions.  To use this action simply add the following step to your deploy process:
 
 ```yaml
-    - name: Deploy to Amazon ECS
-      uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+    - name: Deploy to Amazon ECS Scheduled Tasks
+      uses: airfordable/ecs-deploy-task-definition-to-scheduled-task@v1.0.0
       with:
-        task-definition: task-definition.json
-        service: my-service
         cluster: my-cluster
-        wait-for-service-stability: true
+        task-definition: task-definition.json
 ```
 
 The action can be passed a `task-definition` generated dynamically via [the `aws-actions/amazon-ecs-render-task-definition` action](https://github.com/aws-actions/amazon-ecs-render-task-definition).
@@ -37,7 +38,7 @@ See [action.yml](action.yml) for the full documentation for this action's inputs
 This action relies on the [default behavior of the AWS SDK for Javascript](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) to determine AWS credentials and region.
 Use [the `aws-actions/configure-aws-credentials` action](https://github.com/aws-actions/configure-aws-credentials) to configure the GitHub Actions environment with environment variables containing AWS credentials and your desired region.
 
-We recommend following [Amazon IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) for the AWS credentials used in GitHub Actions workflows, including:
+Amazon recommends following [Amazon IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) for the AWS credentials used in GitHub Actions workflows, including:
 * Do not store credentials in your repository's code.  You may use [GitHub Actions secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) to store credentials and redact credentials from GitHub Actions workflow logs.
 * [Create an individual IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users) with an access key for use in GitHub Actions workflows, preferably one per repository. Do not use the AWS account root user access key.
 * [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) to the credentials used in GitHub Actions workflows.  Grant only the permissions required to perform the actions in your GitHub Actions workflows.  See the Permissions section below for the permissions required by this action.
@@ -70,96 +71,17 @@ This action requires the following minimum set of permissions:
             "arn:aws:iam::<aws_account_id>:role/<task_definition_task_role_name>",
             "arn:aws:iam::<aws_account_id>:role/<task_definition_task_execution_role_name>"
          ]
-      },
-      {
-         "Sid":"DeployService",
-         "Effect":"Allow",
-         "Action":[
-            "ecs:UpdateService",
-            "ecs:DescribeServices"
-         ],
-         "Resource":[
-            "arn:aws:ecs:<region>:<aws_account_id>:service/<cluster_name>/<service_name>"
-         ]
       }
    ]
 }
 ```
 
 Note: the policy above assumes the account has opted in to the ECS long ARN format.
 
-## AWS CodeDeploy Support
-
-For ECS services that uses the `CODE_DEPLOY` deployment controller, additional configuration is needed for this action:
-
-```yaml
-    - name: Deploy to Amazon ECS
-      uses: aws-actions/amazon-ecs-deploy-task-definition@v1
-      with:
-        task-definition: task-definition.json
-        service: my-service
-        cluster: my-cluster
-        wait-for-service-stability: true
-        codedeploy-appspec: appspec.json
-        codedeploy-application: my-codedeploy-application
-        codedeploy-deployment-group: my-codedeploy-deployment-group
-```
-
-The minimal permissions require access to CodeDeploy:
-
-```json
-{
-   "Version":"2012-10-17",
-   "Statement":[
-      {
-         "Sid":"RegisterTaskDefinition",
-         "Effect":"Allow",
-         "Action":[
-            "ecs:RegisterTaskDefinition"
-         ],
-         "Resource":"*"
-      },
-      {
-         "Sid":"PassRolesInTaskDefinition",
-         "Effect":"Allow",
-         "Action":[
-            "iam:PassRole"
-         ],
-         "Resource":[
-            "arn:aws:iam::<aws_account_id>:role/<task_definition_task_role_name>",
-            "arn:aws:iam::<aws_account_id>:role/<task_definition_task_execution_role_name>"
-         ]
-      },
-      {
-         "Sid":"DeployService",
-         "Effect":"Allow",
-         "Action":[
-            "ecs:DescribeServices",
-            "codedeploy:GetDeploymentGroup",
-            "codedeploy:CreateDeployment",
-            "codedeploy:GetDeployment",
-            "codedeploy:GetDeploymentConfig",
-            "codedeploy:RegisterApplicationRevision"
-         ],
-         "Resource":[
-            "arn:aws:ecs:<region>:<aws_account_id>:service/<cluster_name>/<service_name>",
-            "arn:aws:codedeploy:<region>:<aws_account_id>:deploymentgroup:<application_name>/<deployment_group_name>",
-            "arn:aws:codedeploy:<region>:<aws_account_id>:deploymentconfig:*",
-            "arn:aws:codedeploy:<region>:<aws_account_id>:application:<application_name>"
-         ]
-      }
-   ]
-}
-```
-
 ## Troubleshooting
 
 This action emits debug logs to help troubleshoot deployment failures.  To see the debug logs, create a secret named `ACTIONS_STEP_DEBUG` with value `true` in your repository.
 
 ## License Summary
 
 This code is made available under the MIT license.
-
-## Security Disclosures
-
-If you would like to report a potential security issue in this project, please do not create a GitHub issue.  Instead, please follow the instructions [here](https://aws.amazon.com/security/vulnerability-reporting/) or [email AWS security directly](mailto:[email protected]).