From 38d305eee620b5cfc765f288adc72bf639649257 Mon Sep 17 00:00:00 2001 From: Koen Kanters Date: Thu, 16 Oct 2025 20:47:04 +0200 Subject: [PATCH] chore: add new device support bot --- .../workflows/new_device_support_issue.yml | 115 ++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 .github/workflows/new_device_support_issue.yml diff --git a/.github/workflows/new_device_support_issue.yml b/.github/workflows/new_device_support_issue.yml new file mode 100644 index 000000000..2dc4619fe --- /dev/null +++ b/.github/workflows/new_device_support_issue.yml @@ -0,0 +1,115 @@ +name: New Device Support Issue + +on: + issues: + types: [opened, edited] + +permissions: + issues: write + contents: read + +jobs: + comment: + runs-on: ubuntu-latest + steps: + - name: Comment on new device support issue + uses: actions/github-script@v8 + with: + script: | + const issue = context.payload.issue; + + // Only proceed if the issue title starts with "[New device support]" + if (!issue.title || !issue.title.startsWith("[New device support]")) { + return; + } + + // Hide previous bot comments + const comments = await github.rest.issues.listComments({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + }); + + for (const comment of comments.data) { + if (comment.user.type === 'Bot' && comment.user.login === 'github-actions[bot]') { + await github.graphql(` + mutation { + minimizeComment(input: {subjectId: "${comment.node_id}", classifier: OUTDATED}) { + clientMutationId + } + } + `); + } + } + + // Check if Tuya manufacturer name is already supported. + const tuyaManufacturerNameRe = /['"](_T\w+_(\w+))['"]/g; + const tuyaManufacturerNames = Array.from(issue.body.matchAll(tuyaManufacturerNameRe), m => [m[1], m[2]]); + if (tuyaManufacturerNames.length > 0) { + // Checkout the repo and grep for the manufacturer name + const execSync = require('child_process').execSync; + execSync(`git clone https://github.com/Koenkk/zigbee-herdsman-converters.git zhc`, {stdio: 'ignore'}); + + for (const [fullName, partialName] of tuyaManufacturerNames) { + const fullMatch = (() => { try { return execSync(`grep -r --include="*.ts" "${fullName}" zhc`, {encoding: 'utf8'}); } catch { return undefined; } })(); + if (fullMatch) { + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + body: [ + `👋 Hi there! The Tuya device with manufacturer name \`${fullName}\` is already supported in the latest dev branch.`, + "See this [guide](https://www.zigbee2mqtt.io/advanced/more/switch-to-dev-branch.html) on how to update, after updating you can remove your external converter.", + "", + "In case you created the external converter with the goal to extend or fix an issue with the out-of-the-box support, please submit a pull request.", + "For instructions on how to create a pull request, see the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).", + "If you need help with the process, feel free to ask here and we'll be happy to assist." + ].join('\n') + }); + await github.rest.issues.update({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + state: "closed", + }); + return; + } + + const partialMatch = (() => { try { return execSync(`grep -r --include="*.ts" "${partialName}" zhc`, {encoding: 'utf8'}); } catch { return undefined; } })(); + if (partialMatch) { + const candidates = Array.from(partialMatch.matchAll(tuyaManufacturerNameRe), m => m[1]); + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + body: [ + `👋 Hi there! A similar Tuya device of which the manufacturer name also ends with \`_${partialName}\` is already supported.`, + "This means the device can probably be easily be supported by re-using the existing converter.", + "", + "I found the following matches: " + candidates.map((c) => `\`${c}\``).join(', '), + `Try to stop Z2M, change all occurrences of \`${fullName}\` in the \`data/database.db\` to one of the matches above and start Z2M.`, + "Let us know if it works so we can support this device out-of-the-box!", + ].join('\n') + }); + return; + } + } + } + + // Create a request to pull request comment + await github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: issue.number, + body: [ + "🙏 Thank you for creating this issue and sharing your external converter!", + "", + "In case all features work, please submit a pull request on this repository so the device can be supported out-of-the-box with the next release.", + "For instructions on how to create a pull request, see the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).", + "", + "If **NOT** all features work, please follow the [How To Support new devices](https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html)", + tuyaManufacturerNames.length > 0 ? "Since this is a Tuya also consider [How To Support new Tuya devices](https://www.zigbee2mqtt.io/advanced/support-new-devices/02_support_new_tuya_devices.html)" : "", + "", + "If you need help with the process, feel free to ask here and we'll be happy to assist." + ].join('\n') + });