Merge pull request #407 from elsoul/doc

update skeet doc setup ja
elsoul · Apr 15, 2024 · 63000de · 63000de
2 parents e19e5d8 + 4b61902
commit 63000de
Show file tree

Hide file tree

Showing 8 changed files with 393 additions and 143 deletions.
diff --git a/.changeset/red-owls-film.md b/.changeset/red-owls-film.md
@@ -0,0 +1,7 @@
+---
+"skeet-doc": patch
+"@skeet-framework/cli": patch
+"@skeet-framework/ai": patch
+---
+
+Update - skeet doc setup
diff --git a/packages/ai/src/lib/openAIChat.ts b/packages/ai/src/lib/openAIChat.ts
@@ -42,13 +42,6 @@ export const openAIChat = async (
   contents: Array<ChatCompletionMessageParam>,
   config = defaultOpenAIConfig,
 ) => {
-  if (config.organizationKey === '' || config.apiKey === '') {
-    console.error(
-      'CHAT_GPT_ORG and CHAT_GPT_KEY are required in .env file.\n\nor you can pass them as arguments to the function.',
-    )
-    process.exit(1)
-  }
-
   const ai = new OpenAI({
     apiKey,
     organization: organizationKey,

diff --git a/packages/cli/src/cli/get/index.ts b/packages/cli/src/cli/get/index.ts
@@ -32,7 +32,7 @@ export const listSubCommands = () => {
     .action(async () => {
       const { app } = await readOrCreateConfig()
       const res = await getZone(app.projectId, app.name)
-      Logger.dnsSetupLog(res)
+      Logger.dnsSetupLog(res, '<your-load-balancer-ip>')
     })
   get
     .command('secret')

diff --git a/packages/cli/src/cli/init/initLb.ts b/packages/cli/src/cli/init/initLb.ts
@@ -29,15 +29,15 @@ export const initLb = async () => {
   )
   await firebaseFunctionsDeploy(skeetConfig.app.projectId)
 
-  await setupLoadBalancer(
+  const lbIp = await setupLoadBalancer(
     skeetConfig,
     domainInquirer.lbDomain,
     domainInquirer.nsDomain,
   )
   await initArmor()
   await syncArmors()
   const ips = await getZone(skeetConfig.app.projectId, skeetConfig.app.name)
-  Logger.dnsSetupLog(ips)
+  Logger.dnsSetupLog(ips, lbIp)
 }
 
 const requireDomainName = (value: string) => {

diff --git a/packages/cli/src/lib/gcloud/network/createLoadBalancer.ts b/packages/cli/src/lib/gcloud/network/createLoadBalancer.ts
@@ -23,7 +23,7 @@ export const createLoadBalancer = async () => {
       domainAnswer.lbDomain,
       DEFAULT_FUNCTION_NAME,
     )
-    await setupLoadBalancer(
+    const lbIp = await setupLoadBalancer(
       skeetConfig,
       domainAnswer.lbDomain,
       domainAnswer.nsDomain,
@@ -32,7 +32,7 @@ export const createLoadBalancer = async () => {
     await setupArmor(skeetConfig.app.projectId, skeetConfig.app.name)
     await updateArmorCloudConifg()
     const ips = await getZone(skeetConfig.app.projectId, skeetConfig.app.name)
-    Logger.dnsSetupLog(ips)
+    Logger.dnsSetupLog(ips, lbIp)
     return true
   } catch (error) {
     throw new Error(`createLoadBalancer error: ${error}`)

diff --git a/packages/cli/src/lib/logger/logger.ts b/packages/cli/src/lib/logger/logger.ts
@@ -145,7 +145,10 @@ View Emulator UI at : ${chalk.underline('http://127.0.0.1:4000/')}`
     }
   }
 
-  export const dnsSetupLog = (nameServerAddresses: Array<string>) => {
+  export const dnsSetupLog = (
+    nameServerAddresses: Array<string>,
+    lbIp: string,
+  ) => {
     Logger.warning(
       '🚸 === Copy & Paste below nameServer addresses to your DNS Setting === 🚸\n',
     )
@@ -156,7 +159,19 @@ View Emulator UI at : ${chalk.underline('http://127.0.0.1:4000/')}`
     Logger.warning(
       '👷 === https will be ready in about an hour after your DNS settings === 👷\n',
     )
-    Logger.successCheck(`You are all set`)
+    const content = `If you are not utilizing Google DNS, it is necessary to manually configure the A and CAA records.
+Please set up the three records listed below:
+
+DNS Records Setup:
+--------------------------------
+1. A Record:
+   Address: ${lbIp}
+
+2. CAA Records:
+   - 0 issue "pki.goog"
+   - 0 issue "letsencrypt.org"`
+    Logger.normal(content)
+    Logger.successCheck(`\nYou are all set`)
     Logger.normal(`\n📗 Doc: https://skeet.dev`)
   }
 

diff --git a/packages/cli/src/lib/setup/setupLoadBalancer.ts b/packages/cli/src/lib/setup/setupLoadBalancer.ts
@@ -123,6 +123,7 @@ export const setupLoadBalancer = async (
 
     spinner.stop(true)
     console.log(chalk.green('⚖️ Load balancer setup completed successfully!\n'))
+    return ip
   } catch (error) {
     spinner.stop(true)
     Logger.error(`setupLoadBalancer error: ${JSON.stringify(error)}`)