igorkamyshev · igorkamyshev · Nov 23, 2023 · Nov 22, 2023 · Nov 22, 2023 · Nov 22, 2023
diff --git a/.changeset/big-news-wait.md b/.changeset/big-news-wait.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/atomic-router': patch
+---
+
+New beta
diff --git a/.changeset/blue-chefs-own.md b/.changeset/blue-chefs-own.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/atomic-router': patch
+---
+
+One more test
diff --git a/.changeset/lemon-pots-allow.md b/.changeset/lemon-pots-allow.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/atomic-router': patch
+---
+
+Use correct overrides for betas"
diff --git a/.changeset/rare-pets-give.md b/.changeset/rare-pets-give.md
@@ -0,0 +1,12 @@
+---
+'@farfetched/atomic-router': patch
+'@farfetched/core': patch
+'@farfetched/io-ts': patch
+'@farfetched/runtypes': patch
+'@farfetched/solid': patch
+'@farfetched/superstruct': patch
+'@farfetched/typed-contracts': patch
+'@farfetched/zod': patch
+---
+
+Just test change
diff --git a/.changeset/thick-mice-appear.md b/.changeset/thick-mice-appear.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/superstruct': patch
+---
+
+One more beta please
diff --git a/.changeset/thin-comics-arrive.md b/.changeset/thin-comics-arrive.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/runtypes': patch
+---
+
+Expect next version
diff --git a/.changeset/weak-boxes-cheat.md b/.changeset/weak-boxes-cheat.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/atomic-router': patch
+---
+
+Please publish beta
diff --git a/.changeset/witty-pens-sleep.md b/.changeset/witty-pens-sleep.md
@@ -0,0 +1,5 @@
+---
+'@farfetched/io-ts': patch
+---
+
+One more tests
diff --git a/.github/workflows/canary.yml b/.github/workflows/canary.yml
@@ -0,0 +1,80 @@
+name: Canary
+
+on: pull_request
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      # We store information about used changeset in the comment
+      # So we need to find it to check if we need to publish a new canary release
+      # Also we will update this comment with new information in case of new canary release
+      - name: Find comment about previous canary release
+        uses: peter-evans/find-comment@v1
+        id: find_comment
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Farfetched Canary
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'pnpm'
+      - name: Authenticate with NPM
+        run: |
+          echo "//registry.npmjs.org/:_authToken="${{secrets.NPM_TOKEN}}"" > ~/.npmrc
+      - run: pnpm install --frozen-lockfile
+      # Parse latest published version of the canary release and update local package.json for all packages
+      - name: Restore canary release version
+        run: node ./tools/scripts/canary/canary_version_restore.mjs ${{ github.event.pull_request.number }}
+      # Update version in package.json for all packages with changeset and generate pre.json file
+      - run: pnpm changeset pre enter ${{ github.event.pull_request.number }}
+      - run: pnpm changeset version
+      - run: pnpm changeset pre exit
+      # Check if we need to publish a new canary release
+      # it uses pre.json file and information about previous canary relase from the comment
+      - name: Check if new canary release is required
+        id: canary_required
+        run: node ./tools/scripts/canary/canary_required.mjs """${{ steps.find_comment.outputs.comment-body }}""" >> $GITHUB_OUTPUT && cat $GITHUB_OUTPUT
+      - name: Publish canary release
+        if: steps.canary_required.outputs.skipCanary == ''
+        run: pnpm nx run-many --output-style=static --target=publish --all --configuration=canary
+      - name: Retrieve information about latest canary release
+        id: canary_info
+        run: node ./tools/scripts/canary/canary_info.mjs >> $GITHUB_OUTPUT && cat $GITHUB_OUTPUT
+      # In case of absence of the comment we will create it with information about latest canary release
+      - name: Create comment
+        if: steps.find_comment.outputs.comment-id == ''
+        uses: peter-evans/create-or-update-comment@v1
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            # Farfetched Canary
+
+            Latest canary version is ${{ steps.canary_info.outputs.canaryVersion }}
+
+            [More information about canary versions](https://farfetched.pages.dev/releases/canary.html)
+
+            ---
+
+            Used changeset: ${{ steps.canary_info.outputs.usedChangesets }}
+      # Otherwise we will update it with information about latest caanry release,
+      # but only if we published a new canary release
+      - name: Update comment
+        if: steps.find_comment.outputs.comment-id != '' && steps.canary_required.outputs.skipCanary == ''
+        uses: peter-evans/create-or-update-comment@v1
+        with:
+          edit-mode: replace
+          comment-id: ${{ steps.find_comment.outputs.comment-id }}
+          body: |
+            # Farfetched Canary
+
+            Latest canary version is ${{ steps.canary_info.outputs.canaryVersion }}
+
+            [More information about canary versions](https://farfetched.pages.dev/releases/canary.html)
+
+            ---
+
+            Used changeset: ${{ steps.canary_info.outputs.usedChangesets }}
diff --git a/apps/website/docs/releases/canary.md b/apps/website/docs/releases/canary.md
@@ -0,0 +1,91 @@
+---
+sidebar: false
+---
+
+# 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", // [!code --]
+    "@farfetched/core": "npm:@farfetched-canary/core@0.10.7-403.0" // [!code ++]
+  }
+}
+```
+
+2. Install packages
+
+::: code-group
+
+```bash [pnpm]
+pnpm install
+```
+
+```bash [yarn]
+yarn install
+```
+
+```bash [npm]
+npm install
+```
+
+3. 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/*`.
+
+::: details Full mapping
+
+<script setup>
+    import { data as mapping } from './canary_mapping.data'
+</script>
+
+<table>
+    <thead>
+        <tr>
+            <th>Release package name</th>
+            <th>Canary package name</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr v-for="item in mapping">
+            <td><code>{{item.release}}</code></td>
+            <td><code>{{item.canary}}</code></td>
+        </tr>
+    </tbody>
+</table>
+
+:::
+
+### 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](https://semver.org/) 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.
+
+::: details 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`.
+
+:::
diff --git a/apps/website/docs/releases/canary_mapping.data.ts b/apps/website/docs/releases/canary_mapping.data.ts
@@ -0,0 +1,18 @@
+import { createProjectGraphAsync } from '@nrwl/devkit';
+
+process.env.NX_DAEMON = 'false';
+
+export default {
+  async load() {
+    const graph = await createProjectGraphAsync();
+
+    return Object.values(graph.nodes)
+      .filter(
+        (node) => node.type === 'lib' && Boolean(node.data.targets?.build)
+      )
+      .map((node) => ({
+        release: `@farfetched/${node.name}`,
+        canary: `@farfetched-canary/${node.name}`,
+      }));
+  },
+};
diff --git a/apps/website/docs/releases/index.md b/apps/website/docs/releases/index.md
@@ -6,6 +6,10 @@ sidebar: false
 
 Farfetched is mostly been creating in Thailand, so all releases are named after beautiful places in Thailand.
 
+:::tip
+To use unreleased version of Farfetched, please refer to [canary](/releases/canary) page.
+:::
+
 <script setup>
     import { data as releases } from './releases.data'
 </script>

diff --git a/packages/atomic-router/project.json b/packages/atomic-router/project.json
@@ -32,14 +32,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs atomic-router"
+        "command": "node tools/scripts/publish.mjs atomic-router --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",

diff --git a/packages/core/project.json b/packages/core/project.json
@@ -32,14 +32,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs core"
+        "command": "node tools/scripts/publish.mjs core --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",

diff --git a/packages/io-ts/project.json b/packages/io-ts/project.json
@@ -32,14 +32,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs io-ts"
+        "command": "node tools/scripts/publish.mjs io-ts --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",

diff --git a/packages/runtypes/project.json b/packages/runtypes/project.json
@@ -32,14 +32,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs runtypes"
+        "command": "node tools/scripts/publish.mjs runtypes --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",

diff --git a/packages/solid/project.json b/packages/solid/project.json
@@ -33,14 +33,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs solid"
+        "command": "node tools/scripts/publish.mjs solid --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",

diff --git a/packages/superstruct/project.json b/packages/superstruct/project.json
@@ -32,14 +32,19 @@
     "publish": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs superstruct"
+        "command": "node tools/scripts/publish.mjs superstruct --rename={args.rename}"
       },
       "dependsOn": [
         {
           "projects": "self",
           "target": "pack"
         }
-      ]
+      ],
+      "configurations": {
+        "canary": {
+          "args": "--rename=canary"
+        }
+      }
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",