From 28ae5e6f776efbd235cc4137ecb5260ddbe7a039 Mon Sep 17 00:00:00 2001 From: Florian Bachmann <834350+baflo@users.noreply.github.com> Date: Sat, 25 Nov 2023 14:23:06 +0100 Subject: [PATCH] Adds info on stable and beta addon versions (#1978) Co-authored-by: Franck Nijhof --- docs/add-ons/presentation.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/add-ons/presentation.md b/docs/add-ons/presentation.md index 0006f05e..63b182bd 100644 --- a/docs/add-ons/presentation.md +++ b/docs/add-ons/presentation.md @@ -41,6 +41,16 @@ A changelog is a file which contains a curated, chronologically ordered list of For guidance on keeping a changelog, we recommend the [keep a changelog](http://keepachangelog.com) website. They have developed a standard used by many open source projects around the world. +## Offering stable and canary version + +You may consider to offer a stable and a "next" or "canary" branch. These can be provided using different branches. When adding the add-on in Home Assistant, the user can select the wanted branch from a given repository by appending its name following a hashtag. + +```text +https://github.com/home-assistant/hassio-addons-example#next +``` + +You should add this information to your documentation. Also, you should consider having different [names for the repositories](/docs/add-ons/repository#repository-configuration) in every branch, for example, "Super add-on (stable)" and "Super add-on (beta)". + ## AppArmor In the event that an API call returns something you, as a developer were not expecting, access to too many resources could be a liability for your users. As an add-on developer, it is your responsibility to ensure your add-on will not ruin your user's machine, or perform actions that you would never expect. That's where AppArmor comes in.