From 2a26bbea7b5e7073047b028832971341e801745c Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sat, 30 May 2020 16:50:04 +0000 Subject: [PATCH] :tada: Release of add-on Example 3.4.0 --- README.md | 6 +- example/CHANGELOG.md | 9 +-- example/DOCS.md | 134 +++++++++++++++++++++++++++++++++++++++++++ example/README.md | 7 +-- example/config.json | 2 +- 5 files changed, 145 insertions(+), 13 deletions(-) create mode 100644 example/DOCS.md diff --git a/README.md b/README.md index 45094aee..23328f1e 100644 --- a/README.md +++ b/README.md @@ -846,10 +846,10 @@ SOFTWARE. [bookstack-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [bookstack-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [bookstack-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-example]: https://github.com/hassio-addons/addon-example/tree/v3.3.2 -[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v3.3.2/README.md +[addon-example]: https://github.com/hassio-addons/addon-example/tree/v3.4.0 +[addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v3.4.0/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues -[example-version-shield]: https://img.shields.io/badge/version-v3.3.2-blue.svg +[example-version-shield]: https://img.shields.io/badge/version-v3.4.0-blue.svg [example-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/example-armhf.svg [example-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [example-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/example/CHANGELOG.md b/example/CHANGELOG.md index 581c6d7a..f783426e 100644 --- a/example/CHANGELOG.md +++ b/example/CHANGELOG.md @@ -1,11 +1,12 @@ [Full Changelog][changelog] -### :hammer: Changes +### 🔨 Changes -- :arrow_up: Upgrades base image to v7.1.0 -- :hammer: Disable Docker init +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation -[changelog]: https://github.com/hassio-addons/addon-example/compare/v3.3.1...v3.3.2 +[changelog]: https://github.com/hassio-addons/addon-example/compare/v3.3.2...v3.4.0 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/example/DOCS.md b/example/DOCS.md new file mode 100644 index 00000000..a9b498a1 --- /dev/null +++ b/example/DOCS.md @@ -0,0 +1,134 @@ +# Home Assistant Community Add-on: Example + +This is an example add-on for Hass.io. When started, it displays a +random quote every 5 seconds. + +It shows off several features and structures like: + +- Full blown GitHub repository. +- General Dockerfile structure and setup. +- The use of the `config.json` and `build.json` files. +- General shell scripting structure (`run.sh`). +- Quality assurance using CodeClimate. +- Continuous integration and deployment using CircleCI. +- Usage of the Community Hass.io Add-ons build environment. +- Small use of the Bash function library in our base images. +- The use of Docker label schema. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Example" add-on in the Supervisor add-on store and install it. +1. Start the "Example" add-on. +1. Check the logs of the "Example" add-on to see it in action. + +## Configuration + +Eventought this add-on is just an example add-on, it does come with some +configuration options to play around with. + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +seconds_between_quotes: 5 +``` + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `seconds_between_quotes` + +Sets the number of seconds between the output of each quote. The value +must be between `1` and `120` seconds. This value is set to `5` seconds by +default. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2017-2020 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-example/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-example/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-example/releases +[semver]: http://semver.org/spec/v2.0.0.html diff --git a/example/README.md b/example/README.md index a2b56d4a..d4e2b54f 100644 --- a/example/README.md +++ b/example/README.md @@ -27,8 +27,6 @@ It shows off several features and structures like: - Small use of the Bash function library in our base images. - The use of Docker label schema. -[Click here for the full documentation][docs] - ## WARNING! THIS IS A BETA VERSION! This Home Assistant Add-ons repository contains beta releases of add-ons. @@ -47,7 +45,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-example/blob/v3.3.2/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -56,5 +53,5 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v3.3.2-blue.svg -[release]: https://github.com/hassio-addons/addon-example/tree/v3.3.2 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v3.4.0-blue.svg +[release]: https://github.com/hassio-addons/addon-example/tree/v3.4.0 \ No newline at end of file diff --git a/example/config.json b/example/config.json index e7297c3d..dcd44a93 100644 --- a/example/config.json +++ b/example/config.json @@ -1,6 +1,6 @@ { "name": "Example", - "version": "3.3.2", + "version": "3.4.0", "slug": "example", "description": "Example add-on by Community Hass.io Add-ons", "url": "https://github.com/hassio-addons/addon-example",