メモ

[yutaro-sakamoto]

CDKのプロジェクトの作成後にやること

eslintとprettierのインストール

npm install --save-dev eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin typescript-eslint
npm install --save-dev --save-exact prettier
node --eval "fs.writeFileSync('.prettierrc','{}\n')"

eslint.config.mjsに下記の設定を書く

 // @ts-check

import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';

export default tseslint.config(
    eslint.configs.recommended,
    ...tseslint.configs.recommended,
);

package.jsonに下記のような記述を追加する

  "scripts": {
    // 途中は割愛
    "lint": "eslint bin/ lib/",
    "check-lint": "eslint --fix-dry-run bin/ lib/",
    "format": "prettier --ignore-path .gitignore --write '+(bin|lib)/*.+(js|ts|json)'",
    "check-format": "prettier --check --ignore-path .gitignore '+(bin|lib)/*.+(js|ts|json)'"
  },

.git/hook/pre-commitに下記の内容を書き込み、chmod +x .git/hook/pre-commitを実行して実行権限をつける

npm run format
git add -u

GitHub Actionsの設定を行う

name: test 
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4

      - name: npm ci
        run: npm ci

      - name: Format
        run: npm run check-format

      - name: ESLint
        run: npm run check-lint

[yutaro-sakamoto]

参考リンク

• 組織内での AWS CDK 利用拡大のためのベストプラクティス
• AWS CDKベストプラクティス
• CDK Pipelines for GitHub Workflows
• AWS Deployment Pipeline Reference Architecture
• Policy as Code
  • AWS CloudFormation Guard
  • Open Policy Agent
• AWS re:Invent 2022 - Governance and security with infrastructure as code (DOP314)
• AWS CloudFormation Hooks
• CDK Monitoring Constructs
• CDKWakeful
• CDK CFN Guard Validator Plugin
• DevSecOps とは何ですか?
• Building end-to-end AWS DevSecOps CI/CD pipeline with open source SCA, SAST and DAST tools

[yutaro-sakamoto]

以降はリポジトリ内のNote.mdに記載する