Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Refactor to prevent unnecessary lockfile changes #1120

Merged
merged 8 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/integrationTests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions .gitpod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node-linker=hoisted
frozen-lockfile=true
16 changes: 14 additions & 2 deletions docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scripts/smokeTests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ cd "$PROJECT_DIR"

cp .env.example .env

pnpm install -r --frozen-lockfile
pnpm install -r

pnpm build

Expand Down
2 changes: 1 addition & 1 deletion scripts/start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading