Add README.md

README.md

@@ -1,105 +1,37 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
 
-# Create a JavaScript Action using TypeScript
+# CDK diff commenter Action
 
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+This action works on pull request.
+Run cdk synth and calculate difference and drifts of stacks,
+and comment its result to pr.
 
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
+![](docs/demo.png)
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+## Usage
 
-## Create an action from this template
+See [action.yml](action.yml)
 
-Click the `Use this Template` and provide the new repo details for your action
-
-## Code in Main
-
-> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
-
-Install the dependencies  
-```bash
-$ npm install
-```
-
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run package
-```
-
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
-
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
-
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
-```
-
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket: 
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
+### Basic
 
 ```yaml
-uses: ./
-with:
-  milliseconds: 1000
+on:
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - run: npm ci
+
+      - uses: tsuba3/cdk_plan_action@main
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          aws-region: 'ap-northeast-1'
 ```
-
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
-
-## Usage:
-
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action

action.yml

@@ -2,11 +2,16 @@ name: CDK Plan Action
 description: Comment cdk diff to pr
 author: tsuba3
 inputs:
-  cdk-command: # change this
+  cdk-command:
     required: false
-    description: 'input description here'
+    description: 'CDK command to write templates to cdk.out'
     default: 'npx cdk synth'
 
+  cdk-out-dir:
+    required: false
+    description: 'Directory of the synthesized cloud assembly'
+    default: 'cdk.out'
+
   enable-drift-detection:
     required: false
     description: 'Whether run drift detection'

src/main.ts

@@ -22,6 +22,7 @@ import {
 
 const prNumber = core.getInput('pr-number');
 const cdkCommand = core.getInput('cdk-command');
+const cdkOutDir = core.getInput('cdk-out-dir');
 const enableDriftDetection = core.getBooleanInput('enable-drift-detection');
 const awsRegion = core.getInput('aws-region');
 const replaceComments = core.getBooleanInput('replace-comments');
@@ -34,14 +35,14 @@ async function run(): Promise<void> {
   sh(cdkCommand);
 
   // Read templates json files from files in cdk.out
-  const cdkManifest = JSON.parse(fs.readFileSync('cdk.out/manifest.json').toString('utf-8'));
+  const cdkManifest = JSON.parse(fs.readFileSync(`${cdkOutDir}/manifest.json`).toString('utf-8'));
   const stackNames = Object.entries(cdkManifest.artifacts)
     // @ts-ignore
     .filter(([, v]) => v.type === 'aws:cloudformation:stack')
     .map(([k]) => k);
   const stackTemplates: {[k: string]: any} = {};
   for (const stackName of stackNames) {
-    stackTemplates[stackName] = JSON.parse(fs.readFileSync(`cdk.out/${stackName}.template.json`).toString());
+    stackTemplates[stackName] = JSON.parse(fs.readFileSync(`${cdkOutDir}/${stackName}.template.json`).toString());
   }
 
   // Retrieve current templates from CloudFormation