Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

homebridge-ibricks plugin #701

Closed
ubreu opened this issue Mar 10, 2024 · 5 comments
Closed

homebridge-ibricks plugin #701

ubreu opened this issue Mar 10, 2024 · 5 comments
Labels
verified use when a plugin meets the criteria - adds the verified badge text

Comments

@ubreu
Copy link

ubreu commented Mar 10, 2024

Link To GitHub Repo

https://github.com/ubreu/homebridge-ibricks

Link To NPM Package

https://www.npmjs.com/package/@ubreu/homebridge-ibricks

Plugin Icon (Optional)

No response

@ubreu ubreu added the pending the label given to a new verification/icon request label Mar 10, 2024
Copy link

✅ Pre-checks completed successfully.

@bwp91 bwp91 added currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes and removed pending the label given to a new verification/icon request labels Mar 17, 2024
Copy link

github-actions bot commented Mar 17, 2024

  • General
    • The plugin must be of type dynamic platform.
    • The plugin must not offer the same nor less functionality than that of any existing verified plugin.
  • Repo
    • The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.
    • A GitHub release should be created for every new version of your plugin, with release notes.
  • Environment
    • The plugin must run on all supported LTS versions of Node.js, at the time of writing this is Node v18 and v20.
    • The plugin must successfully install and not start unless it is configured.
    • The plugin must not execute post-install scripts that modify the users' system in any way.
    • The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
  • Codebase
    • The plugin must implement the Homebridge Plugin Settings GUI.
    • The plugin must not contain any analytics or calls that enable you to track the user.
    • If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
    • The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.



Comment /check to run checks again.

@bwp91
Copy link
Contributor

bwp91 commented Mar 17, 2024

Hi @ubreu

A couple of things:

  1. Please in the future create a GitHub release each time you publish a new version of the plugin. This is so that the release notes are displayed in the Homebridge UI when a user updates the plugin.

  2. I would recommend a name property in the configuration so that users can change how the plugin name appears in the log. They may want to change `` to something like iBricks. Something like

    "properties": {
       "name": {
         "title": "Name",
         "type": "string",
         "default": "@ubreu/homebridge-ibricks"
       },
       "ibricksServerUrl": {
         "title": "Server URL",
         "type": "string",
         "required": true,
         "format": "hostname", <<--- also added this from https://developers.homebridge.io/#/config-schema#format
         "default": "http://127.0.0.1"
       }
     }

    This means they can change the blue/green part:

    Screenshot 2024-03-17 at 14 49 00

This second item is not needed for verification but is just a nice thing to have!

@bwp91 bwp91 added verified use when a plugin meets the criteria - adds the verified badge text and removed currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Mar 17, 2024
Copy link

Congratulations! Your plugin has been verified.

You can now add one of the Verified by Homebridge badges to your plugin's README:

verified-by-homebridge

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

verified-by-homebridge

[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a ❤️ Donate button on its tile in the Homebridge UI. See https://github.com/homebridge/homebridge/wiki/Donation-Links for instructions.

If for any reason in the future you can no longer maintain your plugin, please consider transferring it to our unmaintained plugins repo. We can take ownership until another willing developer comes along.

Don't forget to join the official Homebridge Discord server, where plugin developers can get tips and advice from other developers and the Homebridge project team in the #plugin-development channel!

Thank you for your contribution to the Homebridge Community.
https://homebridge.io

bwp91 added a commit that referenced this issue Mar 17, 2024
@bwp91 bwp91 closed this as completed Mar 17, 2024
@ubreu
Copy link
Author

ubreu commented Mar 18, 2024

Thanks for your feedback! I have incorporated your feedback and created an official 0.1.0 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified use when a plugin meets the criteria - adds the verified badge text
Projects
None yet
Development

No branches or pull requests

2 participants