Fine tuning of the PIO bot

JanPetterMG · JanPetterMG · commit 09fb5798ef12 · 2026-02-07T18:19:46.000+01:00
diff --git a/.github/scripts/platformio/GitHubCommit.py b/.github/scripts/platformio/GitHubCommit.py
@@ -9,13 +9,14 @@
 
 
 class GitHubCommit:
+    logger: logging.Logger
     major: int = 90
     minor: int = 21
     patch: int = 3
-    path: str = "platformio.ini"
     rest: httpx.Client
 
     def __init__(self) -> None:
+        self.logger = logging.getLogger("Frekvens")
         self.rest = httpx.Client(
             base_url="https://api.github.com",
             headers={
@@ -26,21 +27,20 @@ def __init__(self) -> None:
             },
         )
 
-    def parse(self) -> str:
+    def matrix(self) -> str:
         seen: set[str] = set()
         fragments: list[typing.Tuple[str, str, str, str, str, str, str]] = []
-        with open(self.path, encoding="utf-8") as f:
+        with open("platformio.ini", encoding="utf-8") as f:
             for match in re.finditer(
                 r"https://github\.com/(?P<owner>[^/]+)/(?P<repo>[^/]+)/archive/(?P<commit>[0-9a-f]{40})\.tar\.gz\s*;\s*(?P<tag>.+)",
                 f.read(),
             ):
                 string = match.group(0)
                 if string in seen:
-                    logging.debug("Skipping duplicate: %s", string)
                     continue
                 seen.add(string)
                 package = match.groupdict()
-                pending = self.check(package["owner"], package["repo"], package["commit"], package["tag"])
+                pending = self.check(package["owner"], package["repo"], package["tag"])
                 if pending:
                     fragments.append(
                         (
@@ -70,14 +70,16 @@ def parse(self) -> str:
             ]
         )
 
-    def check(self, owner: str, repo: str, commit: str, tag: str) -> typing.Optional[typing.Tuple[str, str]]:
-        logging.info("Checking for updates to %s/%s %s", owner, repo, tag)
+    def check(self, owner: str, repo: str, tag: str) -> typing.Optional[typing.Tuple[str, str]]:
         try:
             v_tag = packaging.version.Version(tag)
             for release in self.rest.get(f"/repos/{owner}/{repo}/releases").raise_for_status().json():
                 try:
                     v_release = packaging.version.Version(release["tag_name"])
-                    if v_release < v_tag:
+                    if v_release <= v_tag:
+                        continue
+                    elif v_release.is_prerelease:
+                        self.logger.info("Skipping pre-release: %s/%s %s", owner, repo, release["tag_name"])
                         continue
                     days = (
                         datetime.datetime.now(datetime.timezone.utc)
@@ -88,24 +90,27 @@ def check(self, owner: str, repo: str, commit: str, tag: str) -> typing.Optional
                         or (days < self.minor and v_release.minor > v_tag.minor and v_release.major == v_tag.major)
                         or (days < self.patch and v_release.minor == v_tag.minor and v_release.major == v_tag.major)
                     ):
-                        logging.info("Skipping '%s', days since release: %d", release["tag_name"], days)
+                        self.logger.info("On cooldown, skipping: %s/%s %s", owner, repo, release["tag_name"])
                         continue
-                    commits = (
-                        self.rest.get(f"/repos/{owner}/{repo}/commits/{release['tag_name']}").raise_for_status().json()
+                    self.logger.info("Update available: %s/%s %s", owner, repo, release["tag_name"])
+                    return (
+                        self.rest.get(f"/repos/{owner}/{repo}/commits/{release['tag_name']}")
+                        .raise_for_status()
+                        .json()["sha"],
+                        release["tag_name"],
                     )
-                    if commits["sha"] == commit:
-                        logging.info("Up to date")
-                        return None
-                    return (commits["sha"], release["tag_name"])
                 except (httpx.HTTPError, packaging.version.InvalidVersion) as e:
-                    logging.warning(e)
+                    self.logger.warning(e)
         except (httpx.HTTPError, packaging.version.InvalidVersion) as e:
-            logging.error(e)
+            self.logger.error(e)
+        self.logger.info("Up to date: %s/%s %s", owner, repo, tag)
         return None
 
 
 def main() -> None:
-    print(GitHubCommit().parse())
+    logging.basicConfig()
+    logging.getLogger("Frekvens").setLevel(logging.INFO)
+    print(GitHubCommit().matrix())
 
 
 if __name__ == "__main__":
diff --git a/.github/scripts/platformio/PlatformIoRegistry.py b/.github/scripts/platformio/PlatformIoRegistry.py
@@ -10,13 +10,15 @@
 
 class PlatformIoRegistry:
     fragments: list[typing.Tuple[str, str, str, str, str, str]] = []
+    logger: logging.Logger
     major: int = 90
     minor: int = 21
     patch: int = 3
     rest: httpx.Client
     seen: set[str] = set()
 
     def __init__(self) -> None:
+        self.logger = logging.getLogger("Frekvens")
         self.rest = httpx.Client(
             base_url="https://api.registry.platformio.org",
             headers={
@@ -26,7 +28,7 @@ def __init__(self) -> None:
         )
         self.regex = re.compile(r"^(?P<owner>[a-z0-9_-]+)\/(?P<name>[A-Za-z0-9_-]+)\s*@\s*(?P<version>\d+\.\d+\.\d+)$")
 
-    def load(self) -> str:
+    def matrix(self) -> str:
         for _, entries in json.loads(
             subprocess.run(
                 ["pio", "project", "config", "--json-output"], capture_output=True, check=True, text=True
@@ -57,13 +59,11 @@ def load(self) -> str:
         )
 
     def parse(self, type: str, query: str) -> None:
+        if query in self.seen:
+            return
+        self.seen.add(query)
         match = self.regex.fullmatch(query)
         if match:
-            string = match.group(0)
-            if string in self.seen:
-                logging.debug("Skipping duplicate: %s", query)
-                return
-            self.seen.add(string)
             pending = self.check(type, match["owner"], match["name"], match["version"])
             if pending:
                 self.fragments.append(
@@ -73,25 +73,27 @@ def parse(self, type: str, query: str) -> None:
                         match["name"],
                         match["version"],
                         pending,
-                        string,
+                        match.group(0),
                     )
                 )
         else:
-            logging.debug("Unsupported format: %s", query)
+            self.logger.debug("Unsupported format: %s", query)
 
-    def check(self, type: str, owner: str, name: str, _version: str) -> typing.Optional[str]:
-        logging.info("Checking for updates to %s/%s %s", owner, name, _version)
+    def check(self, type: str, owner: str, name: str, version: str) -> typing.Optional[str]:
         try:
-            v_version = packaging.version.Version(_version)
+            v_version = packaging.version.Version(version)
             package = self.rest.get(f"/v3/packages/{owner}/{type}/{name}").raise_for_status().json()
-            for version in package["versions"]:
+            for release in package["versions"]:
                 try:
-                    v_package_version = packaging.version.Version(version["name"])
-                    if v_package_version < v_version:
+                    v_package_version = packaging.version.Version(release["name"])
+                    if v_package_version <= v_version:
+                        continue
+                    elif v_package_version.is_prerelease:
+                        self.logger.info("Skipping pre-release: %s/%s %s", owner, name, release["name"])
                         continue
                     days = (
                         datetime.datetime.now(datetime.timezone.utc)
-                        - datetime.datetime.fromisoformat(version["released_at"].replace("Z", "+00:00"))
+                        - datetime.datetime.fromisoformat(release["released_at"].replace("Z", "+00:00"))
                     ).days
                     if (
                         (days < self.major and v_package_version.major > v_version.major)
@@ -106,21 +108,22 @@ def check(self, type: str, owner: str, name: str, _version: str) -> typing.Optio
                             and v_package_version.major == v_version.major
                         )
                     ):
-                        logging.info("Skipping '%s', days since release: %d", version["name"], days)
+                        self.logger.info("On cooldown, skipping: %s/%s %s", owner, name, release["name"])
                         continue
-                    if version["name"] == _version:
-                        logging.info("Up to date")
-                        return None
-                    return version["name"]
+                    self.logger.info("Update available: %s/%s %s", owner, name, release["name"])
+                    return release["name"]
                 except packaging.version.InvalidVersion as e:
-                    logging.warning(e)
+                    self.logger.warning(e)
         except (httpx.HTTPError, packaging.version.InvalidVersion) as e:
-            logging.error(e)
+            self.logger.error(e)
+        self.logger.info("Up to date: %s/%s %s", owner, name, version)
         return None
 
 
 def main() -> None:
-    print(PlatformIoRegistry().load())
+    logging.basicConfig()
+    logging.getLogger("Frekvens").setLevel(logging.INFO)
+    print(PlatformIoRegistry().matrix())
 
 
 if __name__ == "__main__":
diff --git a/.github/workflows/platformio.yml b/.github/workflows/platformio.yml
@@ -18,10 +18,10 @@ jobs:
     name: Idle check
     runs-on: ubuntu-latest
     outputs:
-      days: ${{ steps.idle.outputs.days }}
+      active: ${{ steps.idle.outputs.active }}
 
     steps:
-      - name: GitHub Script idle counter
+      - name: GitHub Script idle check
         id: idle
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
@@ -31,15 +31,15 @@ jobs:
               repo: context.repo.repo,
               branch: 'main',
             });
-            const days = Math.floor((new Date() - new Date(branch.commit.commit.author.date)) / 86400000).toString();
-            core.info(`Days: ${days}`);
-            core.setOutput("days", days);
+            const active = new Date() - new Date(branch.commit.commit.author.date) <= 90 * 86400000;
+            core.info(`Active: ${active}`);
+            core.setOutput("active", active);
 
-  github-commit:
-    name: GitHub commit
+  github-commits:
+    name: GitHub commits
     needs: idle
     runs-on: ubuntu-latest
-    if: needs.idle.outputs.days <= 90
+    if: needs.idle.outputs.active
     outputs:
       dependency-fragments: ${{ steps.commits.outputs.fragments }}
 
@@ -67,42 +67,53 @@ jobs:
         run: |
           echo "fragments=$(python .github/scripts/platformio/GitHubCommit.py)" >> "$GITHUB_OUTPUT"
 
-  github-commit-handler:
-    name: GitHub commit
-    needs: github-commit
+  github-commit-dependency:
+    name: GitHub commit dependency
+    needs: github-commits
     runs-on: ubuntu-latest
-    if: needs.github-commit.outputs.dependency-fragments != '[]'
+    if: needs.github-commits.outputs.dependency-fragments != '[]'
 
     strategy:
       matrix:
-        fragments: ${{ fromJson(needs.github-commit.outputs.dependency-fragments) }}
+        fragments: ${{ fromJson(needs.github-commits.outputs.dependency-fragments) }}
 
     steps:
       - name: Checkout
         uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
 
+      - name: Git branch check
+        id: branch
+        run: |
+          if git ls-remote --exit-code --heads origin "dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}-${{ matrix.fragments.version_new }}"; then
+            echo "exists=1" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=0" >> "$GITHUB_OUTPUT"
+          fi
+
       - name: Update platformio.ini
+        if: steps.branch.outputs.exists == false
         run: sed -i "s|${{ matrix.fragments.string_old }}|${{ matrix.fragments.string_new }}|g" platformio.ini
 
       - name: Create Pull Request
-
+        if: steps.branch.outputs.exists == false
         uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
         id: pr
         with:
-          title: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
-          branch: dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}-${{ matrix.fragments.version_new }}
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
           body: |
             Bumps [${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}](https://github.com/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}) from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }}.
-            - [Release notes](https://github.com/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}/releases)
-            - [Diff](https://github.com/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}/compare/${{ matrix.fragments.commit_old }}...${{ matrix.fragments.commit_new }})
+            - [Releases](https://github.com/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}/releases)
+            - [Compare changes](https://github.com/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}/compare/${{ matrix.fragments.commit_old }}...${{ matrix.fragments.commit_new }})
+          branch: dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }}-${{ matrix.fragments.version_new }}
           commit-message: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
           labels: |
             dependencies
             firmware
           milestone: ${{ env.milestone }}
+          title: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.repo }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
 
       - name: GitHub Script close superseded
-        if: steps.pr.outputs.pull-request-operation == 'created'
+        if: steps.branch.outputs.exists == false
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
           script: |
@@ -142,10 +153,10 @@ jobs:
             }
 
   platformio-registry:
-    name: PlatformIO registry
+    name: PlatformIO Registry
     needs: idle
     runs-on: ubuntu-latest
-    if: needs.idle.outputs.days <= 90
+    if: needs.idle.outputs.active
     outputs:
       dependency-fragments: ${{ steps.registry.outputs.fragments }}
 
@@ -173,8 +184,8 @@ jobs:
         run: |
           echo "fragments=$(python .github/scripts/platformio/PlatformIoRegistry.py)" >> "$GITHUB_OUTPUT"
 
-  platformio-registry-handler:
-    name: PlatformIO Registry
+  platformio-registry-dependency:
+    name: PlatformIO Registry dependency
     needs: platformio-registry
     runs-on: ubuntu-latest
     if: needs.platformio-registry.outputs.dependency-fragments != '[]'
@@ -187,26 +198,38 @@ jobs:
       - name: Checkout
         uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
 
+      - name: Git branch check
+        id: branch
+        run: |
+          if git ls-remote --exit-code --heads origin "dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}-${{ matrix.fragments.version_new }}"; then
+            echo "exists=1" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=0" >> "$GITHUB_OUTPUT"
+          fi
+
       - name: Update platformio.ini
+        if: steps.branch.outputs.exists == false
         run: sed -i "s|${{ matrix.fragments.string_old }}|${{ matrix.fragments.string_new }}|g" platformio.ini
 
       - name: Create Pull Request
+        if: steps.branch.outputs.exists == false
         uses: peter-evans/create-pull-request@c0f553fe549906ede9cf27b5156039d195d2ece0 # v8.1.0
         id: pr
         with:
-          title: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.name }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
-          branch: dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}-${{ matrix.fragments.version_new }}
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
           body: |
             Bumps [${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}](https://registry.platformio.org/${{ matrix.fragments.type }}/${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}) from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }}.
             - [Releases](https://registry.platformio.org/${{ matrix.fragments.type }}/${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}/versions)
+          branch: dependabot/platformio/${{ matrix.fragments.owner }}/${{ matrix.fragments.name }}-${{ matrix.fragments.version_new }}
           commit-message: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.name }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
           labels: |
             dependencies
             firmware
           milestone: ${{ env.milestone }}
+          title: Bump ${{ matrix.fragments.owner }}/${{ matrix.fragments.name }} from ${{ matrix.fragments.version_old }} to ${{ matrix.fragments.version_new }} in /
 
       - name: GitHub Script close superseded
-        if: steps.pr.outputs.pull-request-operation == 'created'
+        if: steps.branch.outputs.exists == false
         uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
         with:
           script: |
