Fix dependency with heft (#587)

livekit · Aug 9, 2023 · 2648c60 · 2648c60
1 parent f1ed9cf
commit 2648c60
Show file tree

Hide file tree

Showing 6 changed files with 1,475 additions and 288 deletions.
diff --git a/.changeset/early-eagles-tease.md b/.changeset/early-eagles-tease.md
@@ -0,0 +1,5 @@
+---
+"@livekit/api-documenter": patch
+---
+
+Fix dependency annoyance with `@rushstack/heft` by adding it as a dev dependency.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -26,10 +26,6 @@ jobs:
       - name: Install Dependencies
         run: yarn
 
-        # TODO: Remove this when heft is removed as a dependency of tooling/api-documenter.
-      - name: Install Heft
-        run: yarn global add @rushstack/heft
-
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -26,10 +26,6 @@ jobs:
           npm install -g yarn
           yarn install
 
-        # TODO: Remove this when heft is removed as a dependency of tooling/api-documenter.
-      - name: Install Heft
-        run: yarn global add @rushstack/heft
-
       - name: ESLint
         run: yarn lint
 

diff --git a/package.json b/package.json
@@ -39,6 +39,7 @@
   "devDependencies": {
     "@changesets/cli": "^2.26.0",
     "@livekit/changesets-changelog-github": "^0.0.4",
+    "@rushstack/heft": "^0.58.2",
     "glob": "^8.1.0",
     "nodemon": "^2.0.22",
     "prettier": "^2.8.3",

diff --git a/tooling/api-documenter/package.json b/tooling/api-documenter/package.json
@@ -34,6 +34,6 @@
     "@types/resolve": "1.20.2"
   },
   "peerDependencies": {
-    "@rushstack/heft": "^0.55.2"
+    "@rushstack/heft": "^0.58.2"
   }
 }