From 3da924d37912ab08781d8a1d2767c802b6b42c79 Mon Sep 17 00:00:00 2001 From: t0bst4r <82281152+t0bst4r@users.noreply.github.com> Date: Sun, 2 Jun 2024 13:14:46 +0200 Subject: [PATCH] chore: initial project setup --- .github/workflows/release.yml | 56 +++++ .gitignore | 1 + .idea/.gitignore | 5 + .../matthomeassistant-matter-bridge-addon.iml | 12 ++ .idea/modules.xml | 8 + .idea/vcs.xml | 6 + LICENSE | 202 ++++++++++++++++++ README.md | 1 + docker/Dockerfile | 17 ++ matterbridge-home-assistant-addon/Dockerfile | 7 + matterbridge-home-assistant-addon/config.yaml | 19 ++ .../docker-entrypoint.sh | 11 + 12 files changed, 345 insertions(+) create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .idea/.gitignore create mode 100644 .idea/matthomeassistant-matter-bridge-addon.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docker/Dockerfile create mode 100644 matterbridge-home-assistant-addon/Dockerfile create mode 100644 matterbridge-home-assistant-addon/config.yaml create mode 100644 matterbridge-home-assistant-addon/docker-entrypoint.sh diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..40c1701 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,56 @@ +name: release +on: + push: + branches: + - main + workflow_dispatch: {} +jobs: + release: + runs-on: ubuntu-latest + permissions: + contents: write + packages: write + outputs: + release_version: ${{ steps.get_version.outputs.VERSION }} + env: + CI: "true" + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Set git identity + run: |- + git config user.name "github-actions" + git config user.email "github-actions@github.com" + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Get Version + id: get_version + run: echo "VERSION=$(cat matterbridge-home-assistant-addon/config.yaml | grep version | cut -c 10-100)" >> $GITHUB_OUTPUT + + - name: Build + uses: docker/build-push-action@v5 + with: + context: ./docker + push: true + platforms: linux/amd64,linux/arm/v7 + tags: ghcr.io/${{ github.repository }}:${{ steps.get_version.outputs.VERSION }} + + release_github: + name: Publish to GitHub Releases + needs: release + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_REF: ${{ github.sha }} + run: errout=$(mktemp); gh release create "${{needs.release.outputs.release_version}}" -R $GITHUB_REPOSITORY -t "${{needs.release.outputs.release_version}}" --target $GITHUB_REF 2> $errout && true; exitcode=$?; if [ $exitcode -ne 0 ] && ! grep -q "Release.tag_name already exists" $errout; then cat $errout; exit $exitcode; fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..62c8935 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..b58b603 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,5 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/.idea/matthomeassistant-matter-bridge-addon.iml b/.idea/matthomeassistant-matter-bridge-addon.iml new file mode 100644 index 0000000..24643cc --- /dev/null +++ b/.idea/matthomeassistant-matter-bridge-addon.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..11abc6d --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..23279d6 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# replace this diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000..e838f71 --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,17 @@ +FROM node:20-alpine + +ENV MATTERBRIDGE_VERSION "1.2.19" +ENV MATTERBRIDGE_HOME_ASSISTANT_VERSION "0.0.4" + +ENV HOME_ASSISTANT_URL="" +ENV HOME_ASSISTANT_ACCESS_TOKEN="" +ENV HOME_ASSISTANT_CLIENT_CONFIG="{}" + +EXPOSE 8283 +EXPOSE 8284 + +RUN npm install -g matterbridge@${MATTERBRIDGE_VERSION} +RUN npm install -g matterbridge-home-assistant@${MATTERBRIDGE_HOME_ASSISTANT_VERSION} +RUN matterbridge -add matterbridge-home-assistant + +CMD matterbridge -bridge diff --git a/matterbridge-home-assistant-addon/Dockerfile b/matterbridge-home-assistant-addon/Dockerfile new file mode 100644 index 0000000..a24c369 --- /dev/null +++ b/matterbridge-home-assistant-addon/Dockerfile @@ -0,0 +1,7 @@ +ARG BUILD_FROM +FROM $BUILD_FROM + +COPY docker-entrypoint.sh / +RUN chmod a+x /docker-entrypoint.sh + +CMD /docker-entrypoint.sh diff --git a/matterbridge-home-assistant-addon/config.yaml b/matterbridge-home-assistant-addon/config.yaml new file mode 100644 index 0000000..2fa823e --- /dev/null +++ b/matterbridge-home-assistant-addon/config.yaml @@ -0,0 +1,19 @@ +name: Matterbridge-Home-Assistant +description: Populate your Home Assistant instance as Matter Bridge +slug: matterbridge_home_assistant +version: 0.0.4 +image: ghcr.io/matterbridge-home-assistant:0.0.4 +options: + home_assistant_url: "" + home_assistant_access_token: "" + home_assistant_client_config: "{}" +schema: + home_assistant_url: str + home_assistant_access_token: str + home_assistant_client_config: str +host_network: true +webui: http://[HOST]:[PORT:8283]/dashboard +init: false +arch: + - amd64 + - armv7 diff --git a/matterbridge-home-assistant-addon/docker-entrypoint.sh b/matterbridge-home-assistant-addon/docker-entrypoint.sh new file mode 100644 index 0000000..0a41ab8 --- /dev/null +++ b/matterbridge-home-assistant-addon/docker-entrypoint.sh @@ -0,0 +1,11 @@ +#!/usr/bin/with-contenv bashio + +HOME_ASSISTANT_URL=$(bashio::config 'home_assistant_url') +HOME_ASSISTANT_ACCESS_TOKEN=$(bashio::config 'home_assistant_access_token') +HOME_ASSISTANT_CLIENT_CONFIG=$(bashio::config 'home_assistant_client_config') + +export HOME_ASSISTANT_URL +export HOME_ASSISTANT_ACCESS_TOKEN +export HOME_ASSISTANT_CLIENT_CONFIG + +matterbridge -bridge