fix(templates): readme

Author: fouad

.prettierignore

@@ -0,0 +1 @@
+*.md

templates/example/.github/workflows/deploy.example.yaml

@@ -33,6 +33,7 @@ jobs:
         run: |
           aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }} --profile default
           aws configure set aws_secret_access_key ${{ secrets.AWS_SECRET_ACCESS_KEY }} --profile default
+          aws configure set aws_region ${{ env.AWS_REGION }} --profile default
 
       - name: Terraform Format
         id: fmt

templates/example/README.example.md

@@ -1,10 +1,18 @@
 # Indent + {{ runtime }} and {{ integration }}
 
-This repository contains {{ numIntegrations }} integration(s) ({{runtime}}) to pull and apply updates to {{integration}} using [Indent](https://indent.com/docs).
+This repository contains an integration between {{integration}} and [Indent](https://indent.com). Once deployed, you will be able to use this integration with Indent to:
+
+{{#capabilities}}
+- {{{.}}}
+{{/capabilities}}
 
 ## Quicklinks
 
+- [Indent Documentation](https://indent.com/docs)
 - [Indent Support](https://support.indent.com)
+
+**In this repo**
+
 - [GitHub Secrets](./settings/secrets/actions)
 - [GitHub Actions](./actions/workflows/deploy.yaml)
 

templates/scripts/steps/catalog.ts

@@ -4,6 +4,7 @@ export interface CatalogItem {
   runtimes: string[]
   integrations: string[]
   environmentVariables: string[]
+  capabilities: string[]
   links: {
     repoSource: string
   }
@@ -29,6 +30,7 @@ export const catalog: CatalogItem[] = [
       'OKTA_CLIENT_ID',
       'OKTA_PRIVATE_KEY',
     ],
+    capabilities: ['PullUpdate', 'ApplyUpdate'],
     readme: {
       connection: [
         '[Go to Okta > Security > API > Tokens](https://help.okta.com/en-us/Content/Topics/Security/API.htm#create-okta-api-token) and create a new API Token, then give the token a descriptive name like `Indent Auto Approvals`',
@@ -45,6 +47,7 @@ export const catalog: CatalogItem[] = [
     runtimes: ['AWS Lambda'],
     integrations: ['PagerdutyDecisionIntegration'],
     environmentVariables: ['PAGERDUTY_KEY'],
+    capabilities: ['GetDecision'],
     links: {
       repoSource: 'packages/stable/indent-integration-pagerduty',
     },
@@ -63,6 +66,7 @@ export const catalog: CatalogItem[] = [
     integrations: ['TailscaleGroupIntegration'],
     runtimes: ['AWS Lambda'],
     environmentVariables: ['TAILSCALE_TAILNET', 'TAILSCALE_API_KEY'],
+    capabilities: ['PullUpdate', 'ApplyUpdate'],
     links: {
       repoSource: 'packages/stable/indent-integration-tailscale',
     },

templates/scripts/steps/readme.ts

@@ -7,16 +7,17 @@ export async function writeReadme(item: CatalogItem, path) {
   const template = await readFile(path + '/README.example.md', 'utf-8')
 
   // destructure catalogItem
-  const { name, runtimes, integrations, readme } = item
+  const { displayName, runtimes, integrations, readme, capabilities } = item
 
   const { connection, docsLink } = readme
   // render template
   const rendered = Mustache.render(template, {
     runtime: runtimes[0],
-    integration: name,
+    integration: displayName,
     numIntegrations: integrations.length,
     connection,
     docsLink,
+    capabilities,
   })
   await unlink(path + '/README.example.md')
   return await writeFile(path + '/README.md', rendered, 'utf-8')