Merge pull request #2 from gorrion-io/generate-templates

Generate templates

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Setup pnpm
+        uses: pnpm/[email protected]
+        with:
+          run_install: false
+
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install deps (with cache)
+        run: pnpm install
+
+      - name: Run generator
+        run: pnpm run generate-template
+
+      - uses: actions/upload-artifact@v3
+        name: Upload clickup template
+        with:
+          name: clickup-template
+          path: ./clickup-template.csv
+          if-no-files-found: ignore
+
+      - uses: actions/upload-artifact@v3
+        name: Upload jira template
+        with:
+          name: jira-template
+          path: ./jira-template.csv
+          if-no-files-found: ignore

.gitignore

@@ -2,3 +2,6 @@
 .obsidian
 .DS_Store
 node_modules
+
+clickup-template.csv
+jira-template.csv

CHANGELOG.md

@@ -1,5 +1,11 @@
 # production-readiness-checklist
 
+## 1.2.0
+
+### Minor Changes
+
+- add generator
+
 ## 1.1.0
 
 ### Minor Changes

README.md

@@ -16,7 +16,7 @@
 | [CRON jobs should only be handled via one source of truth](./docs/12-crons.md)                                                           | Critical 🔴     | Backend ⚙️, Deployment 🚀                 |                                                                                         |
 | [All password related to the project should be shared via password manager only with corresponding group](./docs/13-passwords.md)          | Critical 🔴     | Security 🔒, Deployment 🚀                | Do not share password, secrets etc. in messages nor host them on git                    |
 | [The app should have a risk management and disaster recovery plan written down and available at any point](./docs/14-risk-management.md)   | Critical 🔴     | Monitoring 👀, Security 🔒, Deployment 🚀 |                                                                                         |
-| [The app has an uptime-monitoring system configured](15-uptime.md)                                                                  | Should have 🟡  | Monitoring 👀, Backend ⚙️, Frontend 🖥    | Leverage health checks. Recommended: https://instatus.com/ or https://betteruptime.com/ |
+| [The app has an uptime-monitoring system configured](./docs/15-uptime.md)                                                                  | Should have 🟡  | Monitoring 👀, Backend ⚙️, Frontend 🖥    | Leverage health checks. Recommended: https://instatus.com/ or https://betteruptime.com/ |
 | [The app has a logging solution configured](./docs/16-logging.md)                                                                          | Should have 🟡  | Monitoring 👀, Backend ⚙️, Frontend 🖥    | Recommended: AWS Cloudwatch or https://betterstack.com/logtail                          |
 | [The auto-scaling solution is enabled](./docs/17-autoscaling.md)                                                                           | Should have 🟡  | Deployment 🚀, Backend ⚙️                 |                                                                                         |
 | [The frontend should be checked periodically in terms of performance](./docs/18-front-perf.md)                                             | Should have 🟡  | Frontend 🖥                               | At least test Core Web Vitals via Chrome Lighthouse                                     |

package.json

@@ -1,9 +1,11 @@
 {
   "name": "production-readiness-checklist",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "",
+  "type": "module",
   "main": "index.js",
   "scripts": {
+    "generate-template": "tsx ./scripts/generate-template.ts",
     "changeset": "changeset",
     "update:version": "changeset version"
   },
@@ -12,6 +14,12 @@
   "license": "ISC",
   "packageManager": "[email protected]",
   "dependencies": {
-    "@changesets/cli": "^2.27.3"
+    "@changesets/cli": "^2.27.3",
+    "remark": "^15.0.1",
+    "remark-gfm": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "tsx": "^4.11.0"
   }
 }