Skip to content
On this page

Canary versions of Farfetched

DANGER

Canary versions are not intended for production use. They can contain bugs and breaking changes, some features can be removed or changed in the stable release.

We release canary versions of Farfetched to allow you to try new features before they are released. Canary versions are published for every PR that contains changesets. You can find the latest canary version of the package for particular PR in the PR comments.

How to use

  1. Replace current versions with the canary versions in package.json
json
{
  "dependencies": {
    "@farfetched/core": "0.10.4", 
    "@farfetched/core": "npm:@farfetched-canary/core@0.10.7-403.0" 
  }
}
  1. Install packages
bash
pnpm install
bash
yarn install
bash
npm install
  1. Test your application with the canary version of Farfetched

Deep-dive

In this section, you can find more details about canary versions publishing process.

Package names

Canary 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/*.

Full mapping
Release package nameCanary package name
@farfetched/atomic-router@farfetched-canary/atomic-router
@farfetched/core@farfetched-canary/core
@farfetched/dev-tools@farfetched-canary/dev-tools
@farfetched/io-ts@farfetched-canary/io-ts
@farfetched/json-schema@farfetched-canary/json-schema
@farfetched/solid@farfetched-canary/solid
@farfetched/runtypes@farfetched-canary/runtypes
@farfetched/superstruct@farfetched-canary/superstruct
@farfetched/typed-contracts@farfetched-canary/typed-contracts
@farfetched/valibot@farfetched-canary/valibot
@farfetched/zod@farfetched-canary/zod

Package versions

Package versions for canary versions of Farfetched are generated automatically by the following rules:

  1. Generate next version of the package according to semver rules based on changesets in the branch.
  2. Add PR number to the end of the version.
  3. Add build number to the end of the version.
Examples
  • If the latest version of the package is 0.10.4 and branch contains changeset for minor change, PR number is 403 and this is the first build for this PR, then the version of the package will be 0.11.0-403.0.

  • 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.

Released under the MIT License.