mirror of https://github.com/hassio-addons/probot-addons-assistant.git synced 2025-05-03 18:31:32 +00:00

Community Hass.io Add-ons Assistant. This bot helps with our GitHub PRs & issues.

Find a file

Franck Nijhof 499c1facb0 ✨ Adds CODEOWNERS file		2018-05-05 23:10:00 +02:00
.github	✨ Adds CODEOWNERS file	2018-05-05 23:10:00 +02:00
.env.example	✨ Adds initial Probot code	2018-05-04 21:40:20 +02:00
.gitignore	✨ Adds initial Probot code	2018-05-04 21:40:20 +02:00
.yamllint	🚀 Adds Probot configurations	2018-05-05 22:50:33 +02:00
CODE_OF_CONDUCT.md	📚 Adds basic documentation files	2018-05-04 21:38:31 +02:00
CONTRIBUTING.md	📚 Adds basic documentation files	2018-05-04 21:38:31 +02:00
LICENSE.md	📚 Adds basic documentation files	2018-05-04 21:38:31 +02:00
package.json	🚑 Fixed move-issues plugin naming	2018-05-05 22:46:27 +02:00
README.md	✨ Adds initial Probot code	2018-05-04 21:40:20 +02:00
yarn.lock	🚑 Fixes package names	2018-05-05 22:43:37 +02:00

README.md

Community Hass.io Add-ons Assistant

About

Community Hass.io Add-ons Assistant is a bot that helps the project by doing all kind of administrative tasks on our PR' and issues.

This app was created using Probot.

Installation

Setup repository

git clone git@github.com:hassio-addons/probot-addons-assistant.git
cd probot-addons-assistant
npm install

Create your own GitHub app: instructions
On your local machine, copy .env.example to .env.
Go to smee.io and click Start a new channel. Set WEBHOOK_PROXY_URL in .env to the URL that you are redirected to.
Create a new GitHub App with:
- Webhook URL: Use your WEBHOOK_PROXY_URL from the previous step.
- Webhook Secret: development.
- Permissions & events
  - Commit statuses (read & write)
  - Pull Requests (read only)
  - Subscribe to events Pull request
Download the private key and move it to your project's directory. It will get picked up by Probot automatically.
Edit .env and set APP_ID to the ID of the app you just created. The App ID can be found in your app settings page here
Run $ npm run dev to start the server

See Probot Deployment documentation if you would like to run your own instance of this app.

Support

Got questions?

You have several options to get them answered:

The Home Assistant Community Forum, we have a dedicated topic on that forum regarding this repository.
The Home Assistant Discord Chat Server for general Home Assistant discussions and questions.
Join the Reddit subreddit in /r/homeassistant

You could also open an issue here 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.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

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.