Skip to content

Commit

Permalink
Delete canary publishing (#501)
Browse files Browse the repository at this point in the history
* Delete canary publishing

* Format
  • Loading branch information
igorkamyshev authored Aug 21, 2024
1 parent f219aa6 commit a15974f
Show file tree
Hide file tree
Showing 9 changed files with 1 addition and 414 deletions.
83 changes: 0 additions & 83 deletions .github/workflows/canary.yml

This file was deleted.

88 changes: 1 addition & 87 deletions apps/website/docs/releases/canary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,90 +2,4 @@
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/[email protected]" // [!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`.

:::
Canary version is not available anymore.
33 changes: 0 additions & 33 deletions apps/website/docs/releases/canary_mapping.data.ts

This file was deleted.

4 changes: 0 additions & 4 deletions apps/website/docs/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ 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>
Expand Down
22 changes: 0 additions & 22 deletions tools/scripts/canary/canary_info.mjs

This file was deleted.

41 changes: 0 additions & 41 deletions tools/scripts/canary/canary_name_change.mjs

This file was deleted.

42 changes: 0 additions & 42 deletions tools/scripts/canary/canary_required.mjs

This file was deleted.

Loading

0 comments on commit a15974f

Please sign in to comment.