cdk-cost-analyzer 0.1.36 → 0.1.37

package/.cdk-cost-analyzer-cache/metadata.json

@@ -2,35 +2,35 @@
   "entries": {
     "AmazonS3:US East (N. Virginia):storageClass:General Purpose|volumeType:Standard": {
       "price": 0.023,
-      "timestamp": 1770993763154
+      "timestamp": 1771000028622
     },
     "AmazonDynamoDB:US East (N. Virginia):group:DDB-ReadUnits|productFamily:Amazon DynamoDB PayPerRequest Throughput": {
       "price": 0.023,
-      "timestamp": 1770993763160
+      "timestamp": 1771000028634
     },
     "AmazonDynamoDB:US East (N. Virginia):group:DDB-WriteUnits|productFamily:Amazon DynamoDB PayPerRequest Throughput": {
       "price": 0.023,
-      "timestamp": 1770993763160
+      "timestamp": 1771000028634
     },
     "AmazonEC2:US East (N. Virginia):capacitystatus:Used|instanceType:t3.micro|operatingSystem:Linux|preInstalledSw:NA|tenancy:Shared": {
       "price": 0.023,
-      "timestamp": 1770993763175
+      "timestamp": 1771000028644
     },
     "AWSLambda:US East (N. Virginia):group:AWS-Lambda-Requests": {
       "price": 0.023,
-      "timestamp": 1770993763183
+      "timestamp": 1771000028649
     },
     "AWSLambda:US East (N. Virginia):group:AWS-Lambda-Duration": {
       "price": 0.023,
-      "timestamp": 1770993763183
+      "timestamp": 1771000028650
     },
     "AmazonS3:EU (Frankfurt):storageClass:General Purpose|volumeType:Standard": {
       "price": 0.023,
-      "timestamp": 1770993771199
+      "timestamp": 1771000037494
     },
     "AmazonS3:invalid-region-123:storageClass:General Purpose|volumeType:Standard": {
       "price": 0.023,
-      "timestamp": 1770993771251
+      "timestamp": 1771000037543
     }
   }
 }

package/README.md

@@ -16,13 +16,14 @@ A TypeScript package that analyzes AWS CDK infrastructure changes and provides c
 - **Configuration Management**: Project-specific configuration for thresholds, usage assumptions, and exclusions
 - **Dual Interface**: Use as a CLI tool for quick analysis or import as a library for programmatic integration
 - **Clear Reporting**: Generate formatted cost reports in text, JSON, or Markdown formats
+- **GitHub Integration**: Native GitHub Action and CLI support to post cost analysis to pull requests with trend indicators
 - **GitLab Integration**: Post cost analysis reports as comments on GitLab merge requests
 - **FinOps Awareness**: Help developers understand cost implications during the development cycle
 
 ## Use Cases
 
 - Analyze single CloudFormation templates for cost estimation
-- Analyze infrastructure changes in GitLab merge requests
+- Analyze infrastructure changes in GitHub pull requests and GitLab merge requests
 - Estimate costs before deploying CDK applications
 - Enforce cost approval gates in CI/CD pipelines
 - Compare different infrastructure configurations
@@ -225,7 +226,164 @@ See the [CI/CD Integration Guide](docs/CI_CD.md) for complete documentation.
 
 ### GitHub Actions Integration
 
-Add to your `.github/workflows/ci.yml`:
+#### Using the GitHub Action
+
+The simplest way to integrate CDK Cost Analyzer into your GitHub workflow is using the official action:
+
+```yaml
+name: Cost Analysis
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  analyze-costs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1
+
+      - name: Run CDK Cost Analysis
+        uses: buildinginthecloud/cdk-cost-analyzer@v1
+        with:
+          path: './infrastructure'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          aws-region: 'us-east-1'
+          config-path: '.cdk-cost-analyzer.yml'
+          comment-strategy: 'update'
+```
+
+#### Action Inputs
+
+| Input | Description | Required | Default |
+|-------|-------------|----------|---------|
+| `path` | Path to CDK app directory | No | `./` |
+| `github-token` | GitHub token for API access | Yes | - |
+| `aws-region` | AWS region for pricing data | No | `us-east-1` |
+| `config-path` | Path to configuration file | No | - |
+| `comment-strategy` | Comment update strategy: `new`, `update`, or `delete-and-new` | No | `update` |
+| `debug` | Enable debug logging | No | `false` |
+
+#### Action Outputs
+
+| Output | Description |
+|--------|-------------|
+| `total-delta` | Total monthly cost delta |
+| `currency` | Currency code (e.g., USD) |
+| `added-count` | Number of added resources |
+| `removed-count` | Number of removed resources |
+| `modified-count` | Number of modified resources |
+| `threshold-passed` | Whether the cost threshold check passed |
+| `threshold-level` | Threshold level triggered (none, warning, or error) |
+
+#### Comment Strategies
+
+- **`new`**: Always create a new comment on each run
+- **`update`** (default): Find and update existing cost analysis comment, or create new if not found
+- **`delete-and-new`**: Delete existing comment and create a new one
+
+#### Example PR Comment Output
+
+The action posts a formatted comment to your pull request:
+
+```markdown
+## 💰 CDK Cost Analysis
+
+**Monthly Cost Impact:** ↗️ +$245.60
+**Percentage Change:** +15.3%
+
+| Metric | Value |
+|--------|-------|
+| Base Monthly Cost | $1,605.40 |
+| Target Monthly Cost | $1,851.00 |
+| Cost Delta | +$245.60 |
+
+### ➕ Added Resources
+
+| Logical ID | Type | Monthly Cost |
+|------------|------|--------------|
+| MyRDSInstance | `AWS::RDS::DBInstance` | $215.20 |
+| MyEC2Instance | `AWS::EC2::Instance` | $30.40 |
+| **Total Added** | | **$245.60** |
+
+---
+*Generated by [cdk-cost-analyzer](https://github.com/buildinginthecloud/cdk-cost-analyzer)*
+```
+
+#### Using CLI in GitHub Actions
+
+You can also use the CLI directly with the `--post-to-github` flag:
+
+```yaml
+name: Cost Analysis
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  analyze-costs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install CDK Cost Analyzer
+        run: npm install -g cdk-cost-analyzer
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-east-1
+
+      - name: Run cost analysis
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cdk-cost-analyzer pipeline \
+            --synth \
+            --cdk-app-path ./infrastructure \
+            --region us-east-1 \
+            --config .cdk-cost-analyzer.yml \
+            --post-to-github \
+            --comment-strategy update
+```
+
+#### Basic CI Workflow
+
+For basic CI testing without cost analysis:
 
 ```yaml
 name: CI
@@ -331,6 +489,37 @@ cost-analysis:
     - merge_requests
 ```
 
+### GitHub Integration
+
+Post cost analysis reports as comments on GitHub pull requests:
+
+```typescript
+import { analyzeCosts, GitHubIntegration } from 'cdk-cost-analyzer';
+
+// Analyze costs
+const result = await analyzeCosts({
+  baseTemplate: baseTemplateContent,
+  targetTemplate: targetTemplateContent,
+  region: 'us-east-1',
+  format: 'markdown'
+});
+
+// Post to GitHub PR
+const github = GitHubIntegration.fromEnvironment();
+await github.postPRComment(
+  'owner',
+  'repo',
+  123,  // PR number
+  result.summary,
+  'update'  // comment strategy: 'new', 'update', or 'delete-and-new'
+);
+```
+
+Environment variables for GitHub integration:
+- `GITHUB_TOKEN`: GitHub API token (required)
+- `GITHUB_API_URL`: GitHub API URL (optional, defaults to `https://api.github.com`)
+- `GITHUB_REPOSITORY`: Repository in `owner/repo` format (set automatically in GitHub Actions)
+
 ## Supported Resource Types
 
 ### Core Resources (Phase 1 & 2)
@@ -498,6 +687,7 @@ The tool handles errors gracefully:
 - **API failures**: Automatic retry with exponential backoff, fallback to cached data
 - **Unsupported resources**: Marked as "unknown cost", analysis continues
 - **GitLab API errors**: Descriptive error messages with HTTP status codes
+- **GitHub API errors**: Descriptive error messages with HTTP status codes
 
 ## Development Roadmap
 
@@ -525,6 +715,7 @@ The tool handles errors gracefully:
 - **Additional Resource Calculators**: NAT Gateway, ALB, NLB, VPC Endpoints
 - **Enhanced CLI**: Pipeline command with synthesis and threshold support
 - **Comprehensive Documentation**: Configuration guide, GitLab CI/CD examples
+- **GitHub Actions Integration**: Native action and CLI support for posting PR comments
 
 ### Phase 4 (Planned)
 
@@ -533,7 +724,6 @@ The tool handles errors gracefully:
 - Cost optimization recommendations
 - Support for Savings Plans and Reserved Instances
 - Additional resource types (CloudFront, ElastiCache, EKS)
-- GitHub Actions integration
 - Slack/Teams notifications
 
 ## Testing

package/action.yml

@@ -0,0 +1,50 @@
+name: 'CDK Cost Analyzer'
+description: 'Analyze AWS CDK infrastructure changes and post cost impact summaries to pull requests'
+author: 'Building in the Cloud'
+branding:
+  icon: 'dollar-sign'
+  color: 'green'
+
+inputs:
+  path:
+    description: 'Path to CDK app directory'
+    required: false
+    default: './'
+  github-token:
+    description: 'GitHub token for API access (required for PR comments)'
+    required: true
+  aws-region:
+    description: 'AWS region for pricing data'
+    required: false
+    default: 'us-east-1'
+  config-path:
+    description: 'Path to cdk-cost-analyzer configuration file'
+    required: false
+  comment-strategy:
+    description: 'Comment update strategy: new, update, or delete-and-new'
+    required: false
+    default: 'update'
+  debug:
+    description: 'Enable debug logging'
+    required: false
+    default: 'false'
+
+outputs:
+  total-delta:
+    description: 'Total monthly cost delta'
+  currency:
+    description: 'Currency code (e.g., USD)'
+  added-count:
+    description: 'Number of added resources'
+  removed-count:
+    description: 'Number of removed resources'
+  modified-count:
+    description: 'Number of modified resources'
+  threshold-passed:
+    description: 'Whether the cost threshold check passed'
+  threshold-level:
+    description: 'Threshold level triggered (none, warning, or error)'
+
+runs:
+  using: 'node20'
+  main: 'dist/action/index.js'