From 8c52b884af2859fffed1453dc3bc5d7e64255c6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robbert=20M=C3=BCller?= Date: Sun, 26 Jul 2020 19:21:31 +0200 Subject: [PATCH] :sparkles: Initial repository setup --- .github/FUNDING.yml | 2 + .github/config.yml | 6 +-- .github/settings.yml | 16 +++--- .github/support.yml | 4 +- .gitlab-ci.yml | 14 +++++ CONTRIBUTING.md | 4 +- LICENSE.md | 2 +- README.md | 119 +++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 151 insertions(+), 16 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .gitlab-ci.yml create mode 100644 README.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..292a6c9 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +--- +ko_fi: mjrider diff --git a/.github/config.yml b/.github/config.yml index 71d2f6d..f5828bb 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -34,14 +34,14 @@ requestInfoUserstoExclude: [] newIssueWelcomeComment: > :wave: Thanks for opening your first issue here! If you're reporting a :bug: bug, please make sure you include steps to reproduce it. - Also, logs, error messages and information about your hardware might be usefull. + Also, logs, error messages and information about your hardware might be useful. # Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome # Comment to be posted to on PRs from first time contributors in your repository newPRWelcomeComment: > - :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: - If your PR gets accepted and merged in, we will invite you to the project :tada: + :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: + If your PR gets accepted and merged in, we will invite you to the project :tada: # Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge diff --git a/.github/settings.yml b/.github/settings.yml index 32a0756..947d6b5 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,8 +1,8 @@ --- repository: - description: "Grafana - Community Hass.io Add-on for Home Assistant" + description: "Prometheus - Home Assistant Community Add-ons" homepage: https://addons.community - topics: grafana, hassio-addons, hassio, hass, home-assistant, homeassistant + topics: prometheus, addon, addons, home-assistant, homeassistant private: false has_issues: true has_projects: false @@ -42,24 +42,24 @@ labels: description: "New features or options." - name: "Type: Support" color: 5319e7 - description: "Marks an issue as an support ticket." + description: "Marks an issue as a support ticket." - name: "Type: Discussion" color: d4c5f9 - description: "Marks an issue as an generic discussion ticket." - - name: "Type: Maintaince" + description: "Marks an issue as a generic discussion ticket." + - name: "Type: Maintenance" color: 2af79e - description: "Generic maintaince tasks, e.g., package updates." + description: "Generic maintenance tasks, e.g., package updates." # Additional markers - name: "Security" color: ee0701 - description: "Marks an security issues that needs to be resolved asap." + description: "Marks a security issue that needs to be resolved asap." - name: "Idea" color: fef2c0 description: "Marks an idea, which might be excepted and implemented." - name: "Incomplete" color: fef2c0 - description: "Marks an PR or issue that is missing information." + description: "Marks a PR or issue that is missing information." - name: "Pull request" color: fbca04 description: "There is an PR opened for this issue." diff --git a/.github/support.yml b/.github/support.yml index 4060944..c59ba8d 100644 --- a/.github/support.yml +++ b/.github/support.yml @@ -12,8 +12,8 @@ supportComment: > support channels to get help with the project. Head over to the - [Home Assistant community forum](https://community.home-assistant.io/?u=frenck) - or join our [Discord](https://discord.gg/c5DvZ4e) chat. + [Home Assistant community forum](https://community.home-assistant.io/) + or join our [Discord](https://discord.me/hassioaddons) chat. # Close issues marked as support requests close: true diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..3a90474 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,14 @@ +--- +include: https://raw.githubusercontent.com/hassio-addons/organization/master/gitlabci/addon.yml + +variables: + ADDON_GITHUB_REPO: "hassio-addons/addon-prometheus" + ADDON_SLUG: "prometheus" + ADDON_TARGET: "prometheus" + + ADDON_ARMHF: "false" + ADDON_I386: "false" + + ADDON_AARCH64_BASE: "hassioaddons/base-aarch64:3.2.1" + ADDON_AMD64_BASE: "hassioaddons/base-amd64:3.2.1" + ADDON_ARMV7_BASE: "hassioaddons/base-armv7:3.2.1" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa5dd3e..64ff635 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,5 +25,5 @@ Even better: You could submit a pull request with a fix / new feature! developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. -[github]: https://github.com/hassio-addons/addon-grafana/issues -[prs]: https://github.com/hassio-addons/addon-grafana/pulls +[github]: https://github.com/hassio-addons/addon-prometheus/issues +[prs]: https://github.com/hassio-addons/addon-prometheus/pulls diff --git a/LICENSE.md b/LICENSE.md index 3ea8973..3092744 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2018 Franck Nijhof +Copyright (c) 2020-2020 Robbert Müller Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md new file mode 100644 index 0000000..862af93 --- /dev/null +++ b/README.md @@ -0,0 +1,119 @@ +# Home Assistant Community Add-on: Prometheus + +[![GitHub Release][releases-shield]][releases] +![Project Stage][project-stage-shield] +[![License][license-shield]](LICENSE.md) + +![Supports aarch64 Architecture][aarch64-shield] +![Supports amd64 Architecture][amd64-shield] +![Supports armhf Architecture][armhf-shield] +![Supports armv7 Architecture][armv7-shield] +![Supports i386 Architecture][i386-shield] + +[![GitLab CI][gitlabci-shield]][gitlabci] +![Project Maintenance][maintenance-shield] +[![GitHub Activity][commits-shield]][commits] + +[![Discord][discord-shield]][discord] +[![Community Forum][forum-shield]][forum] + +The open platform for beautiful analytics and monitoring. + +![Prometheus in the Home Assistant Frontend](images/screenshot.png) + +## About + +.... + +[:books: Read the full add-on documentation][docs] + +## 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. + +## Contributing + +This is an active open-source project. We are always open to people who want to +use the code or contribute to it. + +We have set up a separate document containing our +[contribution guidelines](CONTRIBUTING.md). + +Thank you for being involved! :heart_eyes: + +## Authors & contributors + +The original setup of this repository is by [Robbert Müller][mjrider] + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## We have got some Home Assistant add-ons for you + +Want some more functionality to your Home Assistant instance? + +We have created multiple add-ons for Home Assistant. For a full list, check out +our [GitHub Repository][repository]. + +## License + +MIT License + +Copyright (c) 2020-2020 Robbert Müller + +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. + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-prometheus.svg +[commits]: https://github.com/hassio-addons/addon-prometheus/commits/master +[contributors]: https://github.com/hassio-addons/addon-prometheus/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[docs]: https://github.com/hassio-addons/addon-prometheus/blob/master/prometheus/DOCS.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://example.net +[mjrider]: https://github.com/mjrider +[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png +[github-sponsors]: https://github.com/sponsors/frenck +[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-prometheus/badges/master/pipeline.svg +[gitlabci]: https://gitlab.com/hassio-addons/addon-prometheus/pipelines +[i386-shield]: https://img.shields.io/badge/i386-no-red.svg +[issue]: https://github.com/hassio-addons/addon-prometheus/issues +[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-prometheus.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-Development-yellowgreen.svg +[reddit]: https://reddit.com/r/homeassistant +[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-prometheus.svg +[releases]: https://github.com/hassio-addons/addon-prometheus/releases +[repository]: https://github.com/hassio-addons/repository