Major update to 0.2.0 (#76)

* adding new folders to exclude

* updating the architecture diagrams

* adding / moving helper scripts

* moving the base image assests to source-repo

* adjusting buildspec file with new nfs mount location & adding debug logs

* refactoring poky/poky-ami project & esling formatting

* eslint & jest config refactoring / updates

* library version updates & scripts commands ajdustments

* github workflow adjustment to conform with new script location

* deprecating existing/former cdk libraries and test

* updating package-lock.json

* adding new refactored version of the CDK construct with less dependecies between each other:
 - improve the overall deployment time
 - reduce the number of EFS instance requried (1 from 3 per pipeline)
 - provide reuable resourcess across pipelines (s3 buckets, kms keys, ecr reigistry, etc)
 - remove oprhan code

* updated readme

* updated tests snapshot

* eslint reformatting

* forcing dependency to prevent iam role issue on first run of pipeline

* managin eof / eol with lf only (as I'm working o windows and this can cause issues if env is not configured properly)

* updated test due to dependency change

* moving build assets script out to avoid deployment in dist

* updating reference to build assets script

* adding execute permission

* package.json:
- updated dependencies/devDependencies/peerDependencies
- added license attribute
- switching to yarn
README.md:
- doc adjustement due toyarn switch
- confirmed steps for linking

Yarn switch for the following reasons:
- provides better linking / dependencies management
- faster than npm (somehow)
- enable easier linking when developping

* downsizing codebuild ComputeType to save on cost and because resources are not fully used

* Normalize all the line endings

* forcing lf endings

* adding docker image file to allow uplaod & zip of source repo via cdk assets

* variable renaming to improve readability

* differentiating ProjectKind from deprecated API

* - code refactoring to remove local archive creation (using assets and bucket deployement instead
- variable renaming to improve readability

* minor comment changes

* moving the vmimport bucket class to the deprecated folder

* adjusting the vmimport bucket class import

* removing references to VMImportBucket

* simplifying the build asset script

* excluding the test folder from the dist/build output

* adding excluded folder fom build and eslint

* cleanup and relocation of scripts and assets

* variable renaming to improve readability

* - variable renaming to improve readability
- removed use of custom S3 Bucket object for VM Import (enabled by design if needed)
- updating nag snapshots

* updating script path

* varible renaming to improve readability

* switching to S3 poll trigger

* code cleanup

* adjusting the readme with additional details

* function refactoring

* improving the doc / readme

* minor change in navigation

* adding the ability to use a custom local source path be used to create a pipeline

* switching to codepipeline_actions.S3Trigger.EVENTS,

* - switching to codepipeline_actions.S3Trigger.EVENTS,
- adding a custom project type where you can provide the location of your buildspec

* variable renaming

* - extending create ami script with additional parameters
- adding tags and name to the created ami

* test updates

* removing node 18/20 support

* removing deprecated code

* switching to yarn

* switching to yarn

* fixing shell check

* fixing shell check warnings

* adjusting shell check script path

* pre-commit failures fixes

* pre-commit failures fixes

* adding a post install script to force dist folder generation on install

* reveerting change

* adjusting lifecycle scripts

* updating to Yarn 2 (v4.6.0)

* updating to Yarn 2 (v4.6.0)

* adding package-lock for npm compatibility

* fixing renesas script

* Update doc.yml

update to support yarn

* fixing formatting

---------

Co-authored-by: Abdelhalim Dadouche <[email protected]>

Author: adadouche

.editorconfig

@@ -0,0 +1,9 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/doc.yml

@@ -1,25 +1,42 @@
 name: Typedoc build and deploy doc to GH pages
 on:
-    push:
-        branches: ["main"]
+  push:
+    branches: ["main"]
 
-    workflow_dispatch:
+  workflow_dispatch:
 
 permissions:
-    contents: write
+  contents: write
 jobs:
-    build-and-deploy:
-        runs-on: ubuntu-latest
-        steps:
-        - name: Checkout
-          uses: actions/checkout@v3
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
 
-        - name: Install and Build
-          run: |
-            npm ci
-            npm run doc
+      - uses: actions/checkout@v4
+      - name: Enable Corepack
+        run: corepack enable
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "yarn"
 
-        - name: Deploy
-          uses: JamesIves/github-pages-deploy-action@v4
-          with:
-            folder: dist/docs
+      - name: Install and Build
+        run: |
+          yarn install --immutable
+          yarn run doc
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: dist/docs

.github/workflows/shellcheck.yml

@@ -13,4 +13,4 @@ jobs:
       - name: Install shellcheck
         run: sudo apt-get install shellcheck
       - name: Run shellcheck
-        run: shellcheck assets/*.sh
+        run: for file in $(find ./source-repo -type f -iname "*.sh"); do shellcheck $file; done;

.github/workflows/test-cdk.yml

@@ -13,13 +13,26 @@ jobs:
         node-version: [22.x]
 
     steps:
-      - name: Check out repository code
-        uses: actions/checkout@v3
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - uses: actions/checkout@v4
+      - name: Enable Corepack
+        run: corepack enable
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci
-      - run: npm run check
-      - run: npm run build --if-present
-      - run: npm test
+          cache: "yarn"
+      - run: yarn install --immutable
+      - run: yarn run check
+      - run: yarn run build
+      - run: yarn test

.gitignore

@@ -6,6 +6,15 @@
 node_modules
 dist
 
+# yarn asset
+yarn-install.log
+.yarn/*
+!.yarn/releases/
+!.yarn/plugins/
+!.yarn/versions/
+!.yarn/sdks/
+.pnp.*
+
 # CDK asset staging directory
 .cdk.staging
 cdk.out
@@ -16,3 +25,6 @@ cdk.context.json
 
 # Ignore Mac DS_Store files
 **/.DS_Store
+
+assets
+source-zip

.yarn/sdks/eslint/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "eslint",
+  "version": "9.20.1-sdk",
+  "main": "./lib/api.js",
+  "type": "commonjs",
+  "bin": {
+    "eslint": "./bin/eslint.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/api.js"
+    },
+    "./package.json": "./package.json",
+    "./use-at-your-own-risk": {
+      "types": "./lib/types/use-at-your-own-risk.d.ts",
+      "default": "./lib/unsupported-api.js"
+    },
+    "./rules": {
+      "types": "./lib/types/rules/index.d.ts"
+    },
+    "./universal": {
+      "types": "./lib/types/universal.d.ts",
+      "default": "./lib/universal.js"
+    }
+  }
+}

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules