[Issue-20] Add stuff for CI (#22)

* Add stuff for CI

* Fix eslint

* Fix prettier lint

* Edit GH action workflow file for ci

* Do not pin @types/node

* Add CODEOWNERS

Author: deeheber

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Owner of the entire repository
+
+* @deeheber

.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: ci
+run-name: ${{ github.actor }} has run the ci trigger
+
+on:
+  pull_request:
+    branches:
+      - main
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+
+      - name: setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: install dependencies
+        run: npm ci
+
+      - name: build
+        run: npm run build
+
+      - name: run eslint check
+        run: npm run lint:ci
+
+      - name: run prettier format check
+        run: npm run format:ci
+
+      # TODO uncomment when tests are added
+      # https://github.com/deeheber/small-talk/issues/5
+      # - name: test
+      #   run: npm test
+
+      - name: configure AWS credentials from OIDC
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          # 15 minutes aka shortest time allowed
+          role-duration-seconds: 900
+          role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
+          aws-region: us-east-1
+
+      - name: cdk synth
+        run: npm run synth:quiet

.prettierignore

@@ -12,3 +12,6 @@
 
 # package-lock
 */package-lock.json
+
+# CODEOWNERS
+CODEOWNERS

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  }
+}

bin/small-talk.ts

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 import 'source-map-support/register'
+
 import { App } from 'aws-cdk-lib'
+
 import { SmallTalkStack } from '../lib/small-talk-stack'
 
 const app = new App()

eslint.config.mjs

@@ -0,0 +1,31 @@
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { FlatCompat } from '@eslint/eslintrc'
+import js from '@eslint/js'
+import tsParser from '@typescript-eslint/parser'
+import simpleImportSort from 'eslint-plugin-simple-import-sort'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export default [
+  ...compat.extends('plugin:@typescript-eslint/recommended', 'prettier'),
+  {
+    plugins: {
+      'simple-import-sort': simpleImportSort,
+    },
+    rules: {
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error',
+    },
+    languageOptions: {
+      parser: tsParser,
+    },
+  },
+]

lib/small-talk-stack.ts

@@ -6,11 +6,10 @@ import {
   Stack,
   StackProps,
 } from 'aws-cdk-lib'
-import { Construct } from 'constructs'
 import {
-  StepFunctionsIntegration,
-  RestApi,
   Period,
+  RestApi,
+  StepFunctionsIntegration,
   UsagePlan,
 } from 'aws-cdk-lib/aws-apigateway'
 import {
@@ -32,9 +31,9 @@ import {
   TaskInput,
 } from 'aws-cdk-lib/aws-stepfunctions'
 import { HttpInvoke, LambdaInvoke } from 'aws-cdk-lib/aws-stepfunctions-tasks'
-
-import { join } from 'path'
 import { execSync } from 'child_process'
+import { Construct } from 'constructs'
+import { join } from 'path'
 
 export class SmallTalkStack extends Stack {
   constructor(scope: Construct, id: string, props?: StackProps) {
@@ -52,7 +51,7 @@ export class SmallTalkStack extends Stack {
         logGroupName: hackerNewsFunctionName,
         retention: RetentionDays.ONE_WEEK,
         removalPolicy: RemovalPolicy.DESTROY,
-      }
+      },
     )
     const hackerNewsFunction = new Function(this, hackerNewsFunctionName, {
       description:
@@ -83,8 +82,8 @@ export class SmallTalkStack extends Stack {
               execSync(
                 `pip install -r ${join(
                   hackerNewsFunctionDir,
-                  'requirements.txt'
-                )} -t ${join(outputDir)}`
+                  'requirements.txt',
+                )} -t ${join(outputDir)}`,
               )
               execSync(`cp -r ${hackerNewsFunctionDir}/* ${join(outputDir)}`)
               return true
@@ -116,11 +115,11 @@ export class SmallTalkStack extends Stack {
       connectionName: `${stack}`,
       authorization: Authorization.apiKey(
         'smalltalk-authorization',
-        SecretValue.secretsManager('smalltalk-weather')
+        SecretValue.secretsManager('smalltalk-weather'),
       ),
       queryStringParameters: {
         appid: HttpParameter.fromSecret(
-          SecretValue.secretsManager('smalltalk-weather')
+          SecretValue.secretsManager('smalltalk-weather'),
         ),
       },
     })
@@ -190,7 +189,7 @@ export class SmallTalkStack extends Stack {
     parallel.branch(getTechNewsBranch)
 
     const definition = Chain.start(parallel).next(
-      new Pass(this, 'Combine Results')
+      new Pass(this, 'Combine Results'),
     )
 
     // Step Function
@@ -202,7 +201,7 @@ export class SmallTalkStack extends Stack {
         logGroupName: stateMachineName,
         retention: RetentionDays.ONE_WEEK,
         removalPolicy: RemovalPolicy.DESTROY,
-      }
+      },
     )
     const stateMachine = new StateMachine(this, stateMachineName, {
       stateMachineName,
@@ -228,7 +227,7 @@ export class SmallTalkStack extends Stack {
     const endpoint = api.root.addResource('small-talk')
     endpoint.addMethod(
       'POST',
-      StepFunctionsIntegration.startExecution(stateMachine)
+      StepFunctionsIntegration.startExecution(stateMachine),
     )
 
     const defaultUsagePlan = new UsagePlan(this, 'DefaultUsagePlan', {