Merge pull request #1120 from Sifchain/realitySpiral/lockFileFix

fix: Refactor to prevent unnecessary lockfile changes

Author: monilpat

.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
                   cache: "pnpm"
 
             - name: Install dependencies
-              run: pnpm install --frozen-lockfile
+              run: pnpm install
 
             - name: Run Prettier
               run: pnpm run prettier --check .

.github/workflows/integrationTests.yaml

@@ -38,7 +38,7 @@ jobs:
                   cache: "pnpm"
 
             - name: Install dependencies
-              run: pnpm install -r --frozen-lockfile
+              run: pnpm install -r
 
             - name: Build packages
               run: pnpm build

.gitpod.yml

@@ -4,5 +4,4 @@ tasks:
     init: |
       nvm install v23.3.0
       git checkout $(git describe --tags --abbrev=0)
-    command: pnpm install && pnpm run build 
-  
+    command: pnpm install && pnpm run build

.npmrc

@@ -1 +1,2 @@
 node-linker=hoisted
+frozen-lockfile=true

docs/docs/quickstart.md

@@ -39,12 +39,24 @@ Before getting started with Eliza, ensure you have:
     git checkout $(git describe --tags --abbrev=0)
    ```
 
-   Install dependencies
+   Install dependencies (on initial run)
 
    ```bash
-   pnpm install
+   pnpm install --no-frozen-lockfile
    ```
 
+   # Quickstart Guide Update
+
+**Important Note on pnpm Lockfile Management**
+
+By default, the `pnpm` lockfile will not be updated during installations based off of .npmrc frozen-lockfile=true. To update the lockfile, you need to run the command:
+
+```bash
+pnpm install --no-frozen-lockfile
+```
+
+Please only use this command when you initially instantiating the repo or are bumping the version of a package or adding a new package to your package.json. This practice helps maintain consistency in your project's dependencies and prevents unintended changes to the lockfile.
+
    Build the local libraries
 
    ```bash

scripts/smokeTests.sh

@@ -36,7 +36,7 @@ cd "$PROJECT_DIR"
 
 cp .env.example .env
 
-pnpm install -r --frozen-lockfile
+pnpm install -r
 
 pnpm build
 

scripts/start.sh

@@ -21,7 +21,7 @@ fi
 
 # Install dependencies
 echo -e "\033[1mInstalling dependencies...\033[0m"
-if ! pnpm i; then
+if ! pnpm i ; then
     echo -e "\033[1;31mFailed to install dependencies\033[0m"
     exit 1
 fi