Add docs (#2)

isotoma · Dec 21, 2023 · 3f9bfc2 · 3f9bfc2
1 parent af843ab
commit 3f9bfc2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -20,9 +20,9 @@ jobs:
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-    # - run: npm run docs
-    # - name: Deploy docs
-    #   uses: JamesIves/[email protected]
-    #   with:
-    #     branch: gh-pages
-    #     folder: docs
+    - run: npm run docs
+    - name: Deploy docs
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages
+        folder: docs
diff --git a/package.json b/package.json
@@ -27,7 +27,8 @@
         "version": "auto-changelog --hide-credit -p && git add CHANGELOG.md",
         "_lint": "eslint 'index.ts' 'test/**/*.ts' jest.config.js",
         "lint": "npm run -- _lint --fix",
-        "lint-check": "npm run -- _lint --max-warnings 0"
+        "lint-check": "npm run -- _lint --max-warnings 0",
+        "docs": "typedoc index.ts --includeVersion"
     },
     "peerDependencies": {
         "aws-cdk-lib": "^2.0.0",