From e407b4ab3ab186f749c68a6f255d89746b723c84 Mon Sep 17 00:00:00 2001 From: Tobias Brenner <19689801+brenner-tobias@users.noreply.github.com> Date: Sun, 28 Nov 2021 12:55:29 +0100 Subject: [PATCH] Added repository files --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++ .github/PULL_REQUEST_TEMPLATE.md | 9 +++ .github/dependabot.yaml | 8 +++ .github/labels.yml | 85 +++++++++++++++++++++++ .github/release-drafter.yml | 4 ++ .github/workflows/labels.yaml | 14 ++++ .github/workflows/lint.yaml | 16 +++++ .github/workflows/lock.yaml | 14 ++++ .github/workflows/pr-labels.yaml | 17 +++++ .github/workflows/stale.yaml | 14 ++++ .gitignore | 1 + LICENSE.md | 21 ++++++ README.md | 73 ++++++++++++++++++- repository.yaml | 4 ++ 15 files changed, 333 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/dependabot.yaml create mode 100644 .github/labels.yml create mode 100644 .github/release-drafter.yml create mode 100644 .github/workflows/labels.yaml create mode 100644 .github/workflows/lint.yaml create mode 100644 .github/workflows/lock.yaml create mode 100644 .github/workflows/pr-labels.yaml create mode 100644 .github/workflows/stale.yaml create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 repository.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ca043d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: "" +assignees: "" +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Add-On / Home Assistant Information (please complete the following information):** + +- Add-On Version (e.g. 0.7) +- Supervisor Version (e.g. supervisor-2021.10.8) +- Core Version (e.g. core-2021.11.5) +- Operating System (e.g. Home Assistant OS 6.6) +- Devices (e.g. Raspberry Pi 4 Model B) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2bc5d5f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "" +labels: "" +assignees: "" +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..14f7b5b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +# Proposed Changes + +> (Describe the changes and rationale behind them) + +## Related Issues + +> ([Github link][autolink-references] to related issues or pull requests) + +[autolink-references]: https://help.github.com/articles/autolinked-references-and-urls/ diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..45dd97a --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,8 @@ +--- +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: daily + time: "06:00" diff --git a/.github/labels.yml b/.github/labels.yml new file mode 100644 index 0000000..2d0f68a --- /dev/null +++ b/.github/labels.yml @@ -0,0 +1,85 @@ +--- +- name: "breaking-change" + color: ee0701 + description: "A breaking change for existing users." +- name: "bugfix" + color: ee0701 + description: "Inconsistencies or issues which will cause a problem for users or implementors." +- name: "documentation" + color: 0052cc + description: "Solely about the documentation of the project." +- name: "enhancement" + color: 1d76db + description: "Enhancement of the code, not introducing new features." +- name: "refactor" + color: 1d76db + description: "Improvement of existing code, not introducing new features." +- name: "performance" + color: 1d76db + description: "Improving performance, not introducing new features." +- name: "new-feature" + color: 0e8a16 + description: "New features or options." +- name: "maintenance" + color: 2af79e + description: "Generic maintenance tasks." +- name: "ci" + color: 1d76db + description: "Work that improves the continue integration." +- name: "dependencies" + color: 1d76db + description: "Upgrade or downgrade of project dependencies." + +- name: "in-progress" + color: fbca04 + description: "Issue is currently being resolved by a developer." +- name: "stale" + color: fef2c0 + description: "There has not been activity on this issue or PR for quite some time." +- name: "no-stale" + color: fef2c0 + description: "This issue or PR is exempted from the stable bot." + +- name: "security" + color: ee0701 + description: "Marks a security issue that needs to be resolved asap." +- name: "incomplete" + color: fef2c0 + description: "Marks a PR or issue that is missing information." +- name: "invalid" + color: fef2c0 + description: "Marks a PR or issue that is missing information." + +- name: "beginner-friendly" + color: 0e8a16 + description: "Good first issue for people wanting to contribute to the project." +- name: "help-wanted" + color: 0e8a16 + description: "We need some extra helping hands or expertise in order to resolve this." + +- name: "hacktoberfest" + description: "Issues/PRs are participating in the Hacktoberfest." + color: fbca04 +- name: "hacktoberfest-accepted" + description: "Issues/PRs are participating in the Hacktoberfest." + color: fbca04 + +- name: "priority-critical" + color: ee0701 + description: "This should be dealt with ASAP. Not fixing this issue would be a serious error." +- name: "priority-high" + color: b60205 + description: "After critical issues are fixed, these should be dealt with before any further issues." +- name: "priority-medium" + color: 0e8a16 + description: "This issue may be useful, and needs some attention." +- name: "priority-low" + color: e4ea8a + description: "Nice addition, maybe... someday..." + +- name: "major" + color: b60205 + description: "This PR causes a major version bump in the version number." +- name: "minor" + color: 0e8a16 + description: "This PR causes a minor version bump in the version number." diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..0fb20fa --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,4 @@ +--- +template: | + ## What's Changed + $CHANGES diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml new file mode 100644 index 0000000..23a272f --- /dev/null +++ b/.github/workflows/labels.yaml @@ -0,0 +1,14 @@ +--- +name: Sync labels + +# yamllint disable-line rule:truthy +on: + schedule: + - cron: "34 5 * * *" + workflow_dispatch: + +jobs: + workflows: + uses: hassio-addons/workflows/.github/workflows/labels.yaml@main + secrets: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..0b4711d --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,16 @@ +--- +name: Lint + +# yamllint disable-line rule:truthy +on: + push: + pull_request: + types: + - opened + - reopened + - synchronize + workflow_dispatch: + +jobs: + workflows: + uses: hassio-addons/workflows/.github/workflows/repository-lint.yaml@main diff --git a/.github/workflows/lock.yaml b/.github/workflows/lock.yaml new file mode 100644 index 0000000..1d278d1 --- /dev/null +++ b/.github/workflows/lock.yaml @@ -0,0 +1,14 @@ +--- +name: Lock + +# yamllint disable-line rule:truthy +on: + schedule: + - cron: "0 9 * * *" + workflow_dispatch: + +jobs: + workflows: + uses: hassio-addons/workflows/.github/workflows/lock.yaml@main + secrets: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/pr-labels.yaml b/.github/workflows/pr-labels.yaml new file mode 100644 index 0000000..bc96029 --- /dev/null +++ b/.github/workflows/pr-labels.yaml @@ -0,0 +1,17 @@ +--- +name: PR Labels + +# yamllint disable-line rule:truthy +on: + pull_request_target: + types: + - opened + - labeled + - unlabeled + - synchronize + +jobs: + workflows: + uses: hassio-addons/workflows/.github/workflows/pr-labels.yaml@main + secrets: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml new file mode 100644 index 0000000..a063b17 --- /dev/null +++ b/.github/workflows/stale.yaml @@ -0,0 +1,14 @@ +--- +name: Stale + +# yamllint disable-line rule:truthy +on: + schedule: + - cron: "0 8 * * *" + workflow_dispatch: + +jobs: + workflows: + uses: hassio-addons/workflows/.github/workflows/stale.yaml@main + secrets: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..496ee2c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..5942e3d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2021 Tobias Brenner + +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. diff --git a/README.md b/README.md index 1f82dbf..4e79c09 100644 --- a/README.md +++ b/README.md @@ -1 +1,72 @@ -# ha-addons +# Home Assistant Add-On Reposiroty for Cloudflare + +![Project Stage][project-stage-shield] +![Maintenance][maintenance-shield] +[![License][license-shield]](LICENSE.md) + +## About + +Home Assistant allows anyone to create add-on repositories to share their +add-ons for Home Assistant easily. This repository is one of those repositories, +providing extra Home Assistant add-ons for your installation. + +The primary goal of this repository is to provide an add-on to use Cloudflared. +Additional add-ons might follow in the future. + +## Installation + +Use the following URL to add this repository: + +```txt +https://github.com/brenner-tobias/ha-addons +``` + +## Add-ons provided by this repository + +### ✓ [Cloudflared][addon-cloudflared] + +![Latest Version][cloudflared-version-shield] +![Supports armhf Architecture][cloudflared-armhf-shield] +![Supports armv7 Architecture][cloudflared-armv7-shield] +![Supports aarch64 Architecture][cloudflared-aarch64-shield] +![Supports amd64 Architecture][cloudflared-amd64-shield] +![Supports i386 Architecture][cloudflared-i386-shield] + + + +[:books: Cloudflared add-on documentation][addon-doc-cloudflared] + +## License + +MIT License + +Copyright (c) 2017-2021 Tobias Brenner + +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. + +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/main/README.md +[cloudflared-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[cloudflared-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[cloudflared-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg diff --git a/repository.yaml b/repository.yaml new file mode 100644 index 0000000..1d110ef --- /dev/null +++ b/repository.yaml @@ -0,0 +1,4 @@ +--- +name: Add-On Repository for Cloudflare +url: https://github.com/brenner-tobias/ha-addons +maintainer: Tobia Brenner \ No newline at end of file