{"id":16612551,"url":"https://github.com/taichi/actions-cfn-diff","last_synced_at":"2025-10-29T18:30:49.598Z","repository":{"id":131420803,"uuid":"610795773","full_name":"taichi/actions-cfn-diff","owner":"taichi","description":"GitHub Actions to summarize diffs of CloudFormation stack","archived":false,"fork":false,"pushed_at":"2024-10-29T14:27:34.000Z","size":12205,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-29T17:35:55.202Z","etag":null,"topics":["cdk","cloudformation","github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taichi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-07T13:56:22.000Z","updated_at":"2024-10-29T14:27:26.000Z","dependencies_parsed_at":"2023-09-29T21:18:00.863Z","dependency_job_id":"179d4888-2a1a-4d68-8e6f-e236dd001cff","html_url":"https://github.com/taichi/actions-cfn-diff","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi%2Factions-cfn-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi%2Factions-cfn-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi%2Factions-cfn-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taichi%2Factions-cfn-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taichi","download_url":"https://codeload.github.com/taichi/actions-cfn-diff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238864337,"owners_count":19543520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cdk","cloudformation","github-actions"],"created_at":"2024-10-12T01:42:31.261Z","updated_at":"2025-10-29T18:30:43.499Z","avatar_url":"https://github.com/taichi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# actions-cfn-diff\n\nThis GitHub Actions outputs a Job Summary listing the resources included in the CloudFormation template.\n\n## Precondition\n\n- use [aws-actions/configure-aws-credentials@v4](https://github.com/aws-actions/configure-aws-credentials)\n- setup IAM Role for describe Cloudformation stacks\n  - If you use the CDK lookup role, there is no need to create a new role for actions-cfn-diff. see [Assume role example](#assume-role-example)\n\nThe IAM policy required by this action is as follows\n\n```\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"cloudformation:ListStacks\",\n                \"cloudformation:DetectStackDrift\",\n                \"cloudformation:DetectStackResourceDrift\",\n                \"cloudformation:DescribeStackDriftDetectionStatus\",\n                \"cloudformation:GetTemplate\",\n                \"cloudformation:ListStackResources\"\n            ],\n            \"Resource\": \"*\"\n        }\n    ]\n}\n```\n\n## Basic Usage Example\n\n```\non:\n  pull_request:\n\nname: Build on PullRequest\n\npermissions:\n  id-token: write\n  contents: read\n  pull-requests: write\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: 20\n      - name: Configure AWS credentials\n        uses: aws-actions/configure-aws-credentials@v2\n        with:\n          aws-region: ap-northeast-1\n          role-to-assume: arn:aws:iam::0000000:role/deploy_from_github\n      - name: Set up AWS CDK\n        run: npm install -g aws-cdk\n      - name: Make Cloudformation Templates\n        run: cdk synth\n      - uses: taichi/actions-cfn-diff@v1\n        with:\n          aws-region: ap-northeast-1\n```\n\nSee [action.yml](action.yml) for the full documentation for this action's inputs\nand outputs.\n\n## Assume role Example\n\n```\nname: report example\n\non:\n  pull_request:\n\npermissions:\n  id-token: write\n  contents: read\n  pull-requests: write\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Configure AWS credentials\n        uses: aws-actions/configure-aws-credentials@v2\n        with:\n          aws-region: ap-northeast-1\n          role-to-assume: arn:aws:iam::000000000000:role/cdk-deploy-from-github\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: 20\n          cache: \"npm\"\n      - run: npm ci\n      - run: npm run build\n      - name: Set up AWS CDK\n        run: npm install -g aws-cdk\n      - name: Make Cloudformation Templates\n        run: cdk synth\n      - uses: taichi/actions-cfn-diff@v1\n        with:\n          aws-region: ap-northeast-1\n          role-to-assume: arn:aws:iam::000000000000:role/cdk-hnb659fds-lookup-role-000000000000-ap-northeast-1\n```\n\n## Report Examples\n\n### [Before deploy](https://github.com/taichi/actions-cfn-diff-example/actions/runs/4392834414)\n\n![resource_list](./docs/simple_resource_list.png)\n\n### [Resource update summary](https://github.com/taichi/actions-cfn-diff-example/actions/runs/4394981752)\n\n![update summary](./docs/update_summary.png)\n\n### [Resource update summary with drift](https://github.com/taichi/actions-cfn-diff-example/actions/runs/4395427399)\n\n![update summary with drift](./docs/drift_detection.png)\n\n## Related Tools\n\n- [CDK diff commenter Action](https://github.com/tsuba3/cdk_plan_action)\n- [cdk-notifier](https://github.com/karlderkaefer/cdk-notifier)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaichi%2Factions-cfn-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaichi%2Factions-cfn-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaichi%2Factions-cfn-diff/lists"}