Skip to content

Update copilot-instructions: clarify rush install/update workflow and fix version management example #5782

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
+21 −16
Draft

Update copilot-instructions: clarify rush install/update workflow and fix version management example #5782

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd682fb
Update Rush command guidance in copilot instructions
Copilot Apr 17, 2026
13e8f7c
Refine rush update guidance wording
Copilot Apr 17, 2026
e0668ce
Add rush update --recheck guidance for pnpm-config.json/.pnpmfile.cjs…
Copilot Apr 17, 2026
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
37 changes: 21 additions & 16 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The standard directory structure for a Rush monorepo is as follows:

// Allow certain dependencies to use multiple different versions
"allowedAlternativeVersions": {
"typescript": ["~4.5.0", "~4.6.0"]
"typescript": ["~4.6.0"]
}
}
```
Expand Down Expand Up @@ -193,32 +193,37 @@ Choose the correct command tool based on different scenarios:

## 3.2 Common Commands Explained

1. `rush update`
- Function: Install and update dependencies
1. `rush install`
- Function: Install dependencies based on existing shrinkwrap file
- Features:
- Most common day-to-day dependency command
- Read-only operation, won't modify shrinkwrap file
- Suitable for CI environment
- Important parameters:
- `-p, --purge`: Clean before installation
- `--bypass-policy`: Bypass gitPolicy rules
- `--no-link`: Don't create project symlinks
- `--network-concurrency COUNT`: Limit concurrent network requests
- Use cases:
- After first cloning repository
- After pulling new Git changes
- After modifying package.json
- When dependencies need updating
- After switching branches
- CI/CD pipeline
- Ensuring dependency version consistency
- Avoiding accidental shrinkwrap file updates

2. `rush install`
- Function: Install dependencies based on existing shrinkwrap file
- Features:
- Read-only operation, won't modify shrinkwrap file
- Suitable for CI environment
2. `rush update`
- Function: Update dependencies and lockfiles
- Important parameters:
- `-p, --purge`: Clean before installation
- `--bypass-policy`: Bypass gitPolicy rules
- `--no-link`: Don't create project symlinks
- `--network-concurrency COUNT`: Limit concurrent network requests
- Use cases:
- CI/CD pipeline
- Ensuring dependency version consistency
- Avoiding accidental shrinkwrap file updates
- Run only when `rush install` fails and explicitly reports that `rush update` is required (for example, lockfile out-of-sync errors); do not run it preemptively
- Use `rush update --recheck` when you have modified `pnpm-config.json` or `.pnpmfile.cjs` and expect lockfile changes that bare `rush update` does not produce
- Commit hygiene:
- Commit files modified by `rush update` in a dedicated commit named `(chore) rush update`
- During a rebase, drop all `(chore) rush update` commits, rerun `rush update`, and create a fresh `(chore) rush update` commit so lockfile updates are regenerated from the rebased dependency state

3. `rush build`
- Function: Incremental project build
Expand Down Expand Up @@ -290,7 +295,7 @@ Specify in `rush.json`:

// Allow certain dependencies to use multiple versions
"allowedAlternativeVersions": {
"typescript": ["~4.5.0", "~4.6.0"]
"typescript": ["~4.6.0"]
}
}
```
Expand Down Expand Up @@ -398,7 +403,7 @@ When running commands like `install`, `update`, `build`, `rebuild`, etc., by def
1. Dependency Issue Handling
- Avoid directly using `npm`, `pnpm`, `yarn` package managers
- Use `rush purge` to clean all temporary files
- Run `rush update --recheck` to force check all dependencies
- Run `rush install` first; only run `rush update` if `rush install` explicitly tells you to do so

2. Build Issue Handling
- Use `rush rebuild` to skip cache and perform complete build
Expand Down
Loading