From 4022da25fe631f6e089d8f93a68f79fdd3f7068d Mon Sep 17 00:00:00 2001 From: Goir <586209+goir@users.noreply.github.com> Date: Sun, 2 Jun 2024 17:01:10 +0200 Subject: [PATCH] disable brands --- .github/workflows/hacs.yml | 5 ++-- info.md | 47 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 info.md diff --git a/.github/workflows/hacs.yml b/.github/workflows/hacs.yml index ebc8210..558ae71 100644 --- a/.github/workflows/hacs.yml +++ b/.github/workflows/hacs.yml @@ -13,5 +13,6 @@ jobs: uses: "hacs/action@main" with: category: "integration" - - name: HASS - uses: home-assistant/actions/hassfest@master + ignore: "brands" +# - name: HASS +# uses: home-assistant/actions/hassfest@master diff --git a/info.md b/info.md new file mode 100644 index 0000000..69a2ff5 --- /dev/null +++ b/info.md @@ -0,0 +1,47 @@ +# Notice + +The component and platforms in this repository are not meant to be used by a +user, but as a "blueprint" that custom component developers can build +upon, to make more awesome stuff. + +HAVE FUN! 😎 + +## Why? + +This is simple, by having custom_components look (README + structure) the same +it is easier for developers to help each other and for users to start using them. + +If you are a developer and you want to add things to this "blueprint" that you think more +developers will have use for, please open a PR to add it :) + +## What? + +This repository contains multiple files, here is a overview: + +File | Purpose | Documentation +-- | -- | -- +`.devcontainer.json` | Used for development/testing with Visual Studio Code. | [Documentation](https://code.visualstudio.com/docs/remote/containers) +`.github/ISSUE_TEMPLATE/*.yml` | Templates for the issue tracker | [Documentation](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) +`.vscode/tasks.json` | Tasks for the devcontainer. | [Documentation](https://code.visualstudio.com/docs/editor/tasks) +`custom_components/integration_blueprint/*` | Integration files, this is where everything happens. | [Documentation](https://developers.home-assistant.io/docs/creating_component_index) +`CONTRIBUTING.md` | Guidelines on how to contribute. | [Documentation](https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors) +`LICENSE` | The license file for the project. | [Documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository) +`README.md` | The file you are reading now, should contain info about the integration, installation and configuration instructions. | [Documentation](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) +`requirements.txt` | Python packages used for development/lint/testing this integration. | [Documentation](https://pip.pypa.io/en/stable/user_guide/#requirements-files) + +## How? + +1. Create a new repository in GitHub, using this repository as a template by clicking the "Use this template" button in the GitHub UI. +1. Open your new repository in Visual Studio Code devcontainer (Preferably with the "`Dev Containers: Clone Repository in Named Container Volume...`" option). +1. Rename all instances of the `integration_blueprint` to `custom_components/` (e.g. `custom_components/awesome_integration`). +1. Rename all instances of the `Integration Blueprint` to `` (e.g. `Awesome Integration`). +1. Run the `scripts/develop` to start HA and test out your new integration. + +## Next steps + +These are some next steps you may want to look into: +- Add tests to your integration, [`pytest-homeassistant-custom-component`](https://github.com/MatthewFlamm/pytest-homeassistant-custom-component) can help you get started. +- Add brand images (logo/icon) to https://github.com/home-assistant/brands. +- Create your first release. +- Share your integration on the [Home Assistant Forum](https://community.home-assistant.io/). +- Submit your integration to the [HACS](https://hacs.xyz/docs/publish/start).