Skip to content

Commit

Permalink
docs(root): add canary component guidance
Browse files Browse the repository at this point in the history
Add canary component guidance to versioning page

. #729
  • Loading branch information
GCHQ-Developer-530 committed Feb 20, 2024
1 parent 490b33c commit 77ef962
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion src/content/structured/get-started/releases-versioning.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
path: "/get-started/releases-versions"

date: "2024-02-14"
date: "2024-02-15"

title: "Releases and versions"

Expand Down Expand Up @@ -72,6 +72,48 @@ We consider Beta components acceptable for use in production-ready applications,

We regularly review the stability and reliability of Beta components. When the component meets the criteria it can be transitioned to a stable release.

## Canary components

Canary components are unstable components that are released for testing purposes.

These components should not be used in production apps without understanding the risk that changes may occur in order to fix bugs or improve functionality.

We consider a canary component to be acceptable for moving to Beta once customers have tested its usage and provided enough feedback suggesting they're happy with it.

Canary components can be installed in the same way as our core `@ukic/` packages, but prefixed with canary, e.g. `@ukic/canary-react` or `@ukic/canary-web-components`.

```shell
// Canary Web Components
npm i @ukic/canary-web-components @ukic/fonts

// Canary React
npm i @ukic/canary-react @ukic/fonts
```

A difference between our canary packages and our core `@ukic/` packages is that canary package versions will follow a `<version>-canary.<build-number>` pattern.

<p>
Another difference is that docs for canary components won't appear in the
Components guidance section of this site. Instead, docs can be viewed in our
Storybook instance for either{" "}
<ic-link
target="_blank"
href="https://mi6.github.io/ic-ui-kit/branches/canary/main/react/?path=/docs/getting-started--docs"
rel="noreferer noopener nofollow"
>
React
</ic-link>{" "}
or{" "}
<ic-link
target="_blank"
href="https://mi6.github.io/ic-ui-kit/branches/canary/main/web-components/?path=/docs/getting-started--docs"
rel="noreferer noopener nofollow"
>
web components
</ic-link>
.
</p>

## Supporting previous versions

As the component library matures and new versions arrive, the ICDS team will actively maintain and support the previous major version for up to 6 months. This is to allow the team to provide as much resource as possible on the current version. Any support for the legacy versions will only include security updates and bug fixes. No new features will be added.

0 comments on commit 77ef962

Please sign in to comment.