Skip to content

Commit edf2ac5

Browse files
committed
update CONTRIBUTING.md
1 parent 36eecb1 commit edf2ac5

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

CONTRIBUTING.md

+12-21
Original file line numberDiff line numberDiff line change
@@ -395,33 +395,24 @@ To build a new version and release it on NPM, follow these steps:
395395

396396
## Debugging issues from CI builds
397397

398-
To reproduce issues, it can be helpful to the team to install a specific version of the compiler. To do so:
398+
To reproduce issues, it can be helpful to the team to install a specific version of the compiler.
399399

400-
1. Go to [Actions CI for master](https://github.com/rescript-lang/rescript-compiler/actions/workflows/ci.yml?query=branch%3Amaster)
401-
- If you need a specific branch, select a different one to filter to in the GitHub UI.
402-
1. Select a specific run (likely the latest)
403-
1. Under "Artifacts", download the `npm-packages` artifact and extract it to a folder.
404-
1. In your repository run:
400+
ReScript uses [pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) for continuous releases. Once tests are passed successfully, the bot comment is available.
405401

406-
```console
407-
npm i <path_to_download>/npm-packages/rescript-*.tgz
408-
```
402+
Follow the instructions from the comment, which are like:
409403

410-
If you use Yarn or pnpm, you should override platform package resolutions by [`resolutions`](https://yarnpkg.com/configuration/manifest#resolutions) in Yarn or [`overrides`](https://pnpm.io/settings#overrides) in Pnpm.
404+
```bash
405+
# Use NPM
406+
npm i "https://pkg.pr.new/rescript-lang/rescript@${PR_NUMBER}"
411407

412-
```
413-
{
414-
"resolutions": {
415-
"@rescript/linux-x64": "<path_to_download>/npm-packages/rescript-linux-x64.tgz",
416-
"@rescript/linux-arm64": "<path_to_download>/npm-packages/rescript-linux-arm64.tgz",
417-
"@rescript/darwin-x64": "<path_to_download>/npm-packages/rescript-darwin-x64.tgz",
418-
"@rescript/darwin-arm64": "<path_to_download>/npm-packages/rescript-darwin-arm64.tgz",
419-
"@rescript/win32-x64": "<path_to_download>/npm-packages/rescript-win32-x64.tgz"
420-
}
421-
}
408+
# Use Yarn
409+
yarn add "https://pkg.pr.new/rescript-lang/rescript@${PR_NUMBER}"
410+
411+
# Use pnpm
412+
pnpm add "https://pkg.pr.new/rescript-lang/rescript@${PR_NUMBER}"
422413
```
423414

424-
1. Then attempt to rebuild your project as you would normally.
415+
Then attempt to rebuild your project as you would normally.
425416

426417
## Contribution Licensing
427418

0 commit comments

Comments
 (0)