Skip to content

Commit

Permalink
docs: Add information on the new release philosophy (#1592)
Browse files Browse the repository at this point in the history
  • Loading branch information
dermotduffy authored Sep 28, 2024
1 parent d907ace commit 47d9e39
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Home Assistant > HACS > Frontend > "Explore & Add Integrations" > Frigate Card

- Click `Download this repository with HACS`.

See [Advanced Installation](advanced-installation.md) for other installation resources.
See [Advanced Installation](advanced-installation.md) for other installation resources, or [Rolling Back](./rolling-back.md) to rollback to prior versions.

## Adding your card

Expand Down
14 changes: 13 additions & 1 deletion docs/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,19 @@ instructions](advanced-installation.md?id=manual-installation).

## Releasing

1. Merge a PR that contains only a `package.json` and `const.ts` version number bump (see [this example](https://github.com/dermotduffy/frigate-hass-card/commit/a854187d4a354f8841ad284d75b0afbed7b634c4)).
### Release Philosophy

Post `v6.0.0`, all releases are automated with ([semantic-release](https://github.com/semantic-release/semantic-release)) after every merged commit. This significantly reduces the time between merge and ability for users to try the change, but also entirely removes the "emotional notion" that a new major release version (i.e. `v6` -> `v7`) contains major new features. Rather it may simply contain a single backwards incompatible change.

Releases follow [Semantic Versioning](https://semver.org/) with the following definitions:

- **MAJOR** version changes for any backwards incompatible changes. This means any change that would _require_ users to update their card config, regardless of whether that update is automated or manual.
- **MINOR** version changes for any functionality added in a backwards compatible manner. This may mean new features or behavioral changes that do not require a card update.
- **PATCH** version changes for backward compatible bug fixes

### Manual Releases

1. Merge a PR that contains only a `package.json` version number bump.
1. Go to the [releases page](https://github.com/dermotduffy/frigate-hass-card/releases).
1. A release draft will automatically have been created, click 'Edit'.
1. Use the same version number for the release title and tag.
Expand Down
22 changes: 22 additions & 0 deletions docs/rolling-back.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Rolling Back

There may be many versions of this card (see [release philosophy](./developing.md?id=release-philosophy)). If you experience trouble with one version, you can always rollback to a prior version.

### Rolling Back in HACS

- Open your Home Assistant instance and navigate to `HACS` in the sidebar
- Choose "Frontend"
- Click on "Frigate Card"
- Click on the "Three dots menu"
- Choose "Redownload"
- Select the version you wish to change to
- Click "Download"
- Reload your browser

### Rolling Back Manually

If you didn't use `HACS` to install the card, you're on your own to roll it
back! Generally though this amounts to simply "replacing" an installation with
an older one, by following the [manual
installation](./advanced-installation.md?id=manual-installation) instructions
and simply choosing an older version to install.

0 comments on commit 47d9e39

Please sign in to comment.