init

2021-06-29 12:37:08 +03:00
commit 12fdc96d20
282 changed files with 13627 additions and 0 deletions
--- a/example/CHANGELOG.md
+++ b/example/CHANGELOG.md
@@ -0,0 +1,24 @@
+## What’s changed
+
+## 🐛 Bug fixes
+
+- Fix example script permissions @frenck (#75)
+
+## ⬆️ Dependency updates
+
+- ⬆️ Bump docker/setup-buildx-action from v1.1.2 to v1.2.0 @dependabot (#60)
+- ⬆️ Bump docker/setup-qemu-action from v1.0.2 to v1.1.0 @dependabot (#59)
+- ⬆️ Bump docker/login-action from v1.8.0 to v1.9.0 @dependabot (#61)
+- ⬆️ Bump docker/setup-buildx-action from v1.2.0 to v1.3.0 @dependabot (#62)
+- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#63)
+- ⬆️ Bump frenck/action-addon-linter from 2 to 2.1 @dependabot (#64)
+- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#65)
+- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#66)
+- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#67)
+- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#69)
+- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#68)
+- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#70)
+- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2 @dependabot (#71)
+- ⬆️ Upgrades add-on base image to v9.2.2 @frenck (#72)
+- ⬆️ Upgrades add-on base image to v10.0.0 @frenck (#74)
+- ⬆️ Bump docker/login-action from 1.9.0 to 1.10.0 @dependabot (#73)
--- a/example/DOCS.md
+++ b/example/DOCS.md
@@ -0,0 +1,132 @@
+# Home Assistant Community Add-on: Example
+
+This is an example add-on for Home Assistant. 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 GitLab.
+- Usage of the Community Home Assistant 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 add-on 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.
+
+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-2021 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
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-example/releases
+[semver]: http://semver.org/spec/v2.0.0.html
--- a/example/README.md
+++ b/example/README.md
@@ -0,0 +1,41 @@
+# Home Assistant Community Add-on: Example
+
+[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
+
+[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
+
+[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
+
+[![Support Frenck on Patreon][patreon-shield]][patreon]
+
+Example add-on by Community Home Assistant add-ons.
+
+## About
+
+This is an example add-on for Home Assistant. 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 GitLab.
+- Usage of the Community Home Assistant Add-ons build environment.
+- Small use of the Bash function library in our base images.
+- The use of Docker label schema.
+
+[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
+[discord]: https://discord.me/hassioaddons
+[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
+[github-sponsors]: https://github.com/sponsors/frenck
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
+[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-v4.2.0-blue.svg
+[release]: https://github.com/hassio-addons/addon-example/tree/v4.2.0
--- a/example/config.json
+++ b/example/config.json
@@ -0,0 +1,24 @@
+{
+  "name": "Example",
+  "version": "4.2.0",
+  "slug": "example",
+  "description": "Example add-on by Community Home Assistant Add-ons",
+  "url": "https://github.com/hassio-addons/addon-example",
+  "init": false,
+  "arch": [
+    "aarch64",
+    "amd64",
+    "armhf",
+    "armv7",
+    "i386"
+  ],
+  "options": {
+    "log_level": "info",
+    "seconds_between_quotes": 5
+  },
+  "schema": {
+    "log_level": "list(trace|debug|info|notice|warning|error|fatal)",
+    "seconds_between_quotes": "int(1,120)"
+  },
+  "image": "ghcr.io/hassio-addons/example/{arch}"
+}
--- a/example/icon.png
+++ b/example/icon.png
--- a/example/logo.png
+++ b/example/logo.png
--- a/example/translations/de.yaml
+++ b/example/translations/de.yaml
@@ -0,0 +1,7 @@
+configuration:
+  log_level:
+    description: 'The amount of logging the add-on should do.'
+    name: 'Log level'
+  seconds_between_quotes:
+    description: 'The number of seconds the add-on waits until showing a new quote in the add-on log.'
+    name: 'Sekunden zwischen Zitaten'
--- a/example/translations/en.yaml
+++ b/example/translations/en.yaml
@@ -0,0 +1,10 @@
+---
+configuration:
+  log_level:
+    name: Log level
+    description: The amount of logging the add-on should do.
+  seconds_between_quotes:
+    name: Seconds between quotes
+    description: >-
+      The number of seconds the add-on waits until showing a new quote in the
+      add-on log.
--- a/example/translations/nl.yaml
+++ b/example/translations/nl.yaml
@@ -0,0 +1,7 @@
+configuration:
+  log_level:
+    description: 'Bepaalt het niveau van de logs die de add-on toont.'
+    name: 'Log niveau'
+  seconds_between_quotes:
+    description: 'The number of seconds the add-on waits until showing a new quote in the add-on log.'
+    name: 'Aantal seconden tussen de citaten'