Skip to content

Commit

Permalink
chore: add some beta-related documentation in our support and compati…
Browse files Browse the repository at this point in the history
…bility page
  • Loading branch information
rubencarvalho committed Oct 1, 2024
1 parent 4ff0d21 commit e9af1f6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/beta-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Beta Release
on:
push:
branches:
- ruben/beta-releases
- main

jobs:
release:
Expand Down
14 changes: 14 additions & 0 deletions projects/documentation/content/support-and-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ This page provides comprehensive information on versioning, public APIs, browser

Starting from version 1.0.0, Spectrum Web Components follows semantic versioning ([semver](https://semver.org/)). We regularly release patch versions, which do not contain breaking changes. When a breaking change occurs, it will be done in a major version release to avoid breaking existing applications depending on the old version. Major version releases will be communicated in advance, and migration guides will be provided.

### Beta versions

To provide early access to upcoming releases, we maintain a beta tag that points to the next minor version. The beta tag will always correspond to the next minor version incremented from the latest stable release. For example, if the latest tagged release is `1.2.1`, the beta tag will be `1.3.0-beta.0`.

You can install the beta version of a specific Spectrum Web Components package by using the`@beta` tag with your package manager. For example, to install the beta version of the `@spectrum-web-components/button` package, run:

```bash
yarn add @spectrum-web-components/button@beta
```

Consumers using the beta tag can expect a relatively stable experience but should be prepared for potential changes or issues. This tag is ideal for those who want to preview or test new features before they are officially released.

We encourage consumers to report any issues they encounter. Your feedback is valuable in helping us improve the final release.

## Public APIs

Our public API consists of:
Expand Down

0 comments on commit e9af1f6

Please sign in to comment.