-
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
89d1547
commit e16947b
Showing
1 changed file
with
41 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,46 @@ sidebar: false | |
|
|
||
| # Beta versions of Farfetched | ||
|
|
||
| ## Package names | ||
| We release beta versions of Farfetched to allow you to try new features before they are released. Beta versions are published for every PR that contains changesets. You can find the latest beta version of the package for particular PR in the PR comments. | ||
|
|
||
| ## How to use | ||
|
|
||
| 1. Replace current versions with the beta versions in `package.json` | ||
|
|
||
| ```json | ||
| { | ||
| "dependencies": { | ||
| "@farfetched/core": "0.10.4", // [!code --] | ||
| "@farfetched/core": "npm:@farfetched-canary/[email protected]" // [!code ++] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 2. Install packages | ||
|
|
||
| ::: code-group | ||
|
|
||
| ```bash [pnpm] | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ```bash [yarn] | ||
| yarn install | ||
| ``` | ||
|
|
||
| ```bash [npm] | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. Enjoy new features! | ||
|
|
||
| ::: | ||
|
|
||
| ## Deep-dive | ||
|
|
||
| In this section, you can find more details about beta versions publishing process. | ||
|
|
||
| ### Package names | ||
|
|
||
| Beta versions of Farfetched are published to scope `@farfetched-canary` instead of `@farfetched`. To use them, you need to change the package name in `package.json` from `@farfetched/*` to `@farfetched-canary/*`. | ||
|
|
||
|
|
@@ -31,7 +70,7 @@ Beta versions of Farfetched are published to scope `@farfetched-canary` instead | |
|
|
||
| ::: | ||
|
|
||
| ## Package versions | ||
| ### Package versions | ||
|
|
||
| Package versions for beta versions of Farfetched are generated automatically by the following rules: | ||
|
|
||
|
|
@@ -46,34 +85,3 @@ Package versions for beta versions of Farfetched are generated automatically by | |
| - If the latest version of the package is `0.10.4` and branch contains changeset for `patch` change, PR number is `406` and this is the second build for this PR, then the version of the package will be `0.10.5-406.1`. | ||
|
|
||
| ::: | ||
|
|
||
| ## How to use | ||
|
|
||
| 1. Replace current versions with the beta versions in `package.json` | ||
|
|
||
| ```json | ||
| { | ||
| "dependencies": { | ||
| "@farfetched/core": "0.10.4", // [!code --] | ||
| "@farfetched/core": "npm:@farfetched-canary/[email protected]" // [!code ++] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 2. Install packages | ||
|
|
||
| ::: code-group | ||
|
|
||
| ```bash [pnpm] | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ```bash [yarn] | ||
| yarn install | ||
| ``` | ||
|
|
||
| ```bash [npm] | ||
| npm install | ||
| ``` | ||
|
|
||
| ::: | ||