meteocat 2.2.6 → 2.3.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: "🐞 Bug report"
+about: Report a problem with the integration
+title: "[Bug] "
+labels: bug
+assignees: ""
+---
+
+**IMPORTANT: Please search the issues, including closed issues before opening a new issue.  
+The template is mandatory; failure to use it will result in issue closure.**
+
+---
+
+### Describe the bug
+<!-- A clear and concise description of what the bug is. -->
+
+### To Reproduce
+<!-- Steps to reproduce the behavior. -->
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
+
+### Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+### System details
+- Home Assistant version:
+- meteocat version (from `const.py` or HA startup log):
+- meteocatpy version (from `pip show meteocatpy` in the HA container or HA startup log):
+
+### Debug Logs (meteocat & meteocatpy)
+<!-- Please provide [logs] - Enable debug logging for the component. -->
+
+### Additional context
+<!-- Add any other context about the problem here. -->

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/workflows/autocloser.yaml

@@ -0,0 +1,25 @@
+name: Autocloser
+
+on:
+  issues:
+    types: [opened, edited, reopened]
+  issue_comment:
+    types: [created]
+
+jobs:
+  autoclose:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Autoclose issues that did not follow issue template
+        uses: roots/issue-closer@v1.1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-close-message: >
+            👋 @${{ github.event.issue.user.login }} this issue was automatically closed because it did not follow the 
+            [issue template](https://github.com/figorr/meteocat/issues/new/choose).  
+
+            ⚠️ Reminder:  
+            **IMPORTANT: Please search the issues, including closed issues before opening a new issue.  
+            The template is mandatory; failure to use it will result in issue closure.**
+          issue-pattern: >
+            (Describe the bug|To Reproduce|Expected behavior|System details|Debug Logs)

package/.github/workflows/close-duplicates.yml

@@ -0,0 +1,57 @@
+name: Close duplicate issues
+
+on:
+  issues:
+    types:
+      - labeled
+
+jobs:
+  close-duplicate:
+    runs-on: ubuntu-latest
+    if: github.event.label.name == 'duplicate'
+    steps:
+      - name: Extract linked issue number
+        id: extract
+        run: |
+          body="${{ github.event.issue.body }}"
+          # Convertimos a minúsculas para que el match sea insensible a mayúsculas
+          lower=$(echo "$body" | tr '[:upper:]' '[:lower:]')
+
+          # Buscamos "closed as duplicate of #123" o "duplicate of #123"
+          if [[ "$lower" =~ closed[[:space:]]+as[[:space:]]+duplicate[[:space:]]+of[[:space:]]+#([0-9]+) ]]; then
+            echo "number=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT
+          elif [[ "$lower" =~ duplicate[[:space:]]+of[[:space:]]+#([0-9]+) ]]; then
+            echo "number=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Close issue
+        if: steps.extract.outputs.number != ''
+        uses: peter-evans/close-issue@v2
+        with:
+          issue-number: ${{ github.event.issue.number }}
+          comment: |
+            Closed as duplicate of #${{ steps.extract.outputs.number }}.
+            Please follow the discussion there.
+
+      - name: Update title
+        if: steps.extract.outputs.number != ''
+        uses: actions-ecosystem/action-edit-issue@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          issue_number: ${{ github.event.issue.number }}
+          title: "[Duplicate] ${{ github.event.issue.title }}"
+
+      - name: Remove duplicate label
+        if: steps.extract.outputs.number != ''
+        uses: actions-ecosystem/action-remove-labels@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          issue_number: ${{ github.event.issue.number }}
+          labels: duplicate
+
+      - name: Lock conversation
+        if: steps.extract.outputs.number != ''
+        uses: dessant/lock-threads@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-lock-reason: "resolved"

package/.github/workflows/publish-zip.yml

@@ -0,0 +1,67 @@
+name: Publish zip
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-zip:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      # Paso 1: Checkout del repositorio completo
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: master
+          fetch-depth: 0
+
+      # Paso 2: Obtener la versión del release recién publicado
+      - name: Get release version
+        id: release-version
+        run: |
+          version="${GITHUB_REF#refs/tags/v}"
+          echo "Release version: $version"
+          echo "version=$version" >> $GITHUB_OUTPUT
+
+      # Paso 3: Actualizar hacs.json con la última versión de Home Assistant
+      - name: Get latest Home Assistant version
+        id: ha-version
+        run: |
+          latest=$(curl -s https://api.github.com/repos/home-assistant/core/releases/latest | jq -r .tag_name)
+          latest_clean=${latest#v}
+          echo "ha_version=$latest_clean" >> $GITHUB_OUTPUT
+
+      - name: Update hacs.json
+        run: |
+          ha_version="${{ steps.ha-version.outputs.ha_version }}"
+          jq --arg ver "$ha_version" '.homeassistant = $ver' hacs.json > tmp.json && mv tmp.json hacs.json
+
+      - name: Commit updated hacs.json
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add hacs.json
+          if git commit -m "chore: update hacs.json with latest Home Assistant version [skip ci]"; then
+            git push origin master
+          else
+            echo "No changes to commit"
+          fi
+
+      # Paso 4: Crear zip de la integración con nombre fijo meteocat.zip
+      - name: Zip integration
+        run: |
+          cd custom_components/meteocat
+          zip -r "$GITHUB_WORKSPACE/meteocat.zip" ./
+          echo "Zip created at $GITHUB_WORKSPACE/meteocat.zip"
+
+      # Paso 5: Subir meteocat.zip al release de GitHub
+      - name: Upload meteocat.zip to release
+        uses: softprops/action-gh-release@v2.2.1
+        with:
+          files: meteocat.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yml

@@ -11,27 +11,59 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      # Paso 1: Configurar el repositorio
+      # Paso 1: Checkout completo (necesario para semantic-release y tags)
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
-      # Paso 2: Configurar Node.js (requerido para semantic-release)
+      # Paso 2: Configurar Node.js
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 20.8.1 # Versión compatible con semantic-release
+          node-version: 20.8.1
 
-      # Paso 3: Instalar dependencias necesarias
+      # Paso 3: Instalar dependencias
       - name: Install dependencies
         run: npm ci
-      
+
       # Paso 4: Configurar el autor de Git
       - name: Configure Git author
         run: |
           git config user.name "semantic-release-bot"
           git config user.email "jdcuartero@yahoo.es"
 
-      # Paso 5: Ejecutar semantic-release
+      # Paso 5: Obtener próxima versión (dry-run)
+      - name: Get next version
+        id: nextver
+        run: |
+          version=$(npx semantic-release --dry-run | grep "The next release version is" | awk '{print $NF}')
+          echo "next_version=$version" >> $GITHUB_OUTPUT
+          echo "Next version: $version"
+
+      # Paso 6: Actualizar archivos de versión antes del release
+      - name: Update version in files
+        run: |
+          version=${{ steps.nextver.outputs.next_version }}
+
+          # pyproject.toml
+          sed -i "s/^version = \".*\"/version = \"$version\"/" pyproject.toml
+
+          # manifest.json
+          jq --arg ver "$version" '.version = $ver' custom_components/meteocat/manifest.json > tmp.json && mv tmp.json custom_components/meteocat/manifest.json
+
+          # version.py
+          echo "__version__ = \"$version\"" > custom_components/meteocat/version.py
+
+          # __init__.py
+          sed -i "s/^__version__ = \".*\"/__version__ = \"$version\"/" custom_components/meteocat/__init__.py
+
+          # Commit con [skip ci] para no reiniciar workflow
+          git add pyproject.toml custom_components/meteocat/manifest.json custom_components/meteocat/version.py custom_components/meteocat/__init__.py
+          git commit -m "chore: bump version to $version [skip ci]" || echo "No changes to commit"
+          git push origin master
+
+      # Paso 7: Ejecutar semantic-release (generación de release, changelog, assets)
       - name: Run semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }}

package/.github/workflows/stale.yml

@@ -49,3 +49,15 @@ jobs:
             This bug report has had no activity for 3 weeks.
             It has been marked as *help wanted* and will remain open.
           stale-issue-label: "help wanted"
+
+      # 4. Issues con "logs required" sin actividad (cerrar en 14 días)
+      - uses: actions/stale@v8
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          only-labels: "logs required"
+          days-before-stale: 7
+          days-before-close: 1
+          stale-issue-message: >-
+            This issue has been marked as *requiring logs*, but no activity has been detected for 7 days.
+            Since logs were not provided, this issue will now be closed in 1 day.
+          stale-issue-label: "stale"

package/.github/workflows/sync-gitlab.yml

@@ -0,0 +1,94 @@
+name: Sync to GitLab
+
+on:
+  release:
+    types: [published]  # Se dispara al publicarse un release en GitHub
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Paso 1: Checkout completo
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      # Paso 2: Configurar Git
+      - name: Configure Git
+        run: |
+          git config user.name "github-bot"
+          git config user.email "bot@github.com"
+
+      # Paso 3: Añadir remoto de GitLab
+      - name: Add GitLab remote
+        env:
+          GL_REMOTE_URL: ${{ secrets.GL_REMOTE_URL }}
+          GL_TOKEN: ${{ secrets.GL_TOKEN }}
+        run: |
+          git remote add gitlab "https://oauth2:${GL_TOKEN}@${GL_REMOTE_URL#https://}"
+
+      # Paso 4: Comprobar divergencias en master
+      - name: Check for diverging commits
+        run: |
+          git fetch gitlab master
+          if ! git merge-base --is-ancestor gitlab/master master; then
+            echo "❌ GitLab master tiene commits que GitHub no tiene. Revisar antes de sincronizar."
+            exit 1
+
+      # Paso 5: Push de commits y tags a GitLab
+      - name: Push commits and tags to GitLab
+        run: |
+          git push gitlab master
+          git push gitlab --tags
+
+      # Paso 6: Crear release en GitLab si no existe
+      - name: Create GitLab release
+        env:
+          GL_REMOTE_URL: ${{ secrets.GL_REMOTE_URL }}
+          GL_TOKEN: ${{ secrets.GL_TOKEN }}
+          RELEASE_TAG: ${{ github.ref_name }}
+        run: |
+          PROJECT_PATH=$(echo $GL_REMOTE_URL | sed -E 's#https://[^/]+/(.*)\.git#\1#')
+          PROJECT_PATH_ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('''$PROJECT_PATH''', safe=''))")
+
+          EXISTING=$(curl -s --header "PRIVATE-TOKEN: $GL_TOKEN" "https://gitlab.com/api/v4/projects/$PROJECT_PATH_ENCODED/releases/$RELEASE_TAG")
+
+          if echo "$EXISTING" | grep -q 'tag_name'; then
+            echo "Release ya existe en GitLab: $RELEASE_TAG"
+          else
+            echo "Creando release en GitLab: $RELEASE_TAG"
+            curl -s --request POST "https://gitlab.com/api/v4/projects/$PROJECT_PATH_ENCODED/releases" \
+              --header "PRIVATE-TOKEN: $GL_TOKEN" \
+              --header "Content-Type: application/json" \
+              --data "{
+                \"name\": \"Release $RELEASE_TAG\",
+                \"tag_name\": \"$RELEASE_TAG\",
+                \"description\": \"Release sincronizado desde GitHub\"
+              }"
+          fi
+
+      # Paso 7: Subir meteocat.zip como asset al release de GitLab
+      - name: Upload meteocat.zip to GitLab release
+        env:
+          GL_REMOTE_URL: ${{ secrets.GL_REMOTE_URL }}
+          GL_TOKEN: ${{ secrets.GL_TOKEN }}
+          RELEASE_TAG: ${{ github.ref_name }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          PROJECT_PATH=$(echo $GL_REMOTE_URL | sed -E 's#https://[^/]+/(.*)\.git#\1#')
+          PROJECT_PATH_ENCODED=$(python3 -c "import urllib.parse; print(urllib.parse.quote('''$PROJECT_PATH''', safe=''))")
+
+          ASSET_NAME="meteocat.zip"
+          ZIP_URL="https://github.com/${GITHUB_REPOSITORY}/releases/download/$RELEASE_TAG/meteocat.zip"
+
+          echo "Subiendo $ASSET_NAME al release de GitLab desde $ZIP_URL"
+          curl --request POST "https://gitlab.com/api/v4/projects/$PROJECT_PATH_ENCODED/releases/$RELEASE_TAG/assets/links" \
+            --header "PRIVATE-TOKEN: $GL_TOKEN" \
+            --header "Content-Type: application/json" \
+            --data "{
+              \"name\": \"$ASSET_NAME\",
+              \"url\": \"$ZIP_URL\"
+            }"
+

package/.releaserc

@@ -10,14 +10,7 @@
       }
     ],
     "@semantic-release/npm",
-    "@semantic-release/github",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["CHANGELOG.md", "package.json", "pyproject.toml"],
-        "message": "v${nextRelease.version}\n\n${nextRelease.notes}"
-      }
-    ]
+    "@semantic-release/github"
   ],
   "repositoryUrl": "https://github.com/figorr/meteocat"
 }

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+# [2.3.0](https://github.com/figorr/meteocat/compare/v2.2.7...v2.3.0) (2025-09-10)
+
+
+### Features
+
+* download and save town and station json files during setup ([7b98c22](https://github.com/figorr/meteocat/commit/7b98c22d5ca43d4cbf80895e11c02594208f7470))
+* include options documentation ([a85ef74](https://github.com/figorr/meteocat/commit/a85ef7492eb8ed4af99b8d0f50b8e77ff7f7976a))
+* include options image ([dbb047a](https://github.com/figorr/meteocat/commit/dbb047a6bdf32af03fec8351c9a608593b369e3b))
+* include regenerate assets files option ([f2ce357](https://github.com/figorr/meteocat/commit/f2ce357c8ce6371d97523870f4bf6a9cba6a151c))
+* recover assets files ([f493b33](https://github.com/figorr/meteocat/commit/f493b33e54e10994b6b08232f37dd5bb35f4a9b7))
+* regenerate assets option translation ([317ce9f](https://github.com/figorr/meteocat/commit/317ce9fecc03f88b8b8072b41b357846fb075dcc))
+* safe remove keeping common entry files ([6cefe04](https://github.com/figorr/meteocat/commit/6cefe04289b1b74fe30d615e7056bd643d845b89))
+* **storage:** moving the API downloaded files to the new folder meteocat_files ([06c68e3](https://github.com/figorr/meteocat/commit/06c68e36b5669efc8fe3174a71e41624e9728b07))
+* update .gitignore ([fac7772](https://github.com/figorr/meteocat/commit/fac7772a1093f2165e1b33098631096138617a6d))
+* update README ([9855939](https://github.com/figorr/meteocat/commit/98559398e6bae30e8e9c9ff2b2fe27409a3930bd))
+* update repo files structure ([0778679](https://github.com/figorr/meteocat/commit/0778679d218a89e89bb18791f1245c5c9f7b188f))
+
+## [2.2.7](https://github.com/figorr/meteocat/compare/v2.2.6...v2.2.7) (2025-08-29)
+
+
+### Bug Fixes
+
+* 2.2.7 ([ece96b9](https://github.com/figorr/meteocat/commit/ece96b983e6ba5df8a2811fdb86452857cadbb18))
+* fix HACS info ([ae829fa](https://github.com/figorr/meteocat/commit/ae829fa09047bd57d8f5aa8eae746bf31f3a30db))
+* Fix meteor case sensitive for alerts sensors ([d247476](https://github.com/figorr/meteocat/commit/d24747660175d2c305fcffbbae6472ccd490cfb1))
+* Fix umbral case insensitive ([73d6b58](https://github.com/figorr/meteocat/commit/73d6b5808acf8c896a7d822cab7640607f430b37))
+* Fix warning log when an umbral is not in UMBRAL_MAPPING ([adf3511](https://github.com/figorr/meteocat/commit/adf351111e8cb14cba3fd2f2868496701b445b97))
+* Include warning when umbral is not at UMBRAL_MAPPING ([c1b1f75](https://github.com/figorr/meteocat/commit/c1b1f75d7b6a219fbce4580a29e85e168127998e))
+
 ## [2.2.6](https://github.com/figorr/meteocat/compare/v2.2.5...v2.2.6) (2025-08-27)
 
 

package/README.md

@@ -2,7 +2,11 @@
 ![Meteocat Banner](images/banner.png)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Python version compatibility](https://img.shields.io/pypi/pyversions/meteocat)](https://pypi.org/project/meteocat)
-[![pipeline status](https://gitlab.com/figorr/meteocat/badges/master/pipeline.svg)](https://gitlab.com/figorr/meteocat/commits/master)
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration)
+[![Validate](https://github.com/figorr/meteocat/actions/workflows/validate.yaml/badge.svg)](https://github.com/figorr/meteocat/actions/workflows/validate.yaml)
+[![Release](https://github.com/figorr/meteocat/actions/workflows/release.yml/badge.svg)](https://github.com/figorr/meteocat/actions/workflows/release.yml)
+![GitHub all releases](https://img.shields.io/github/downloads/figorr/meteocat/total)
+![GitHub release (latest by SemVer)](https://img.shields.io/github/downloads/figorr/meteocat/latest/total)
 
 
 This is a project to obtain meteorological data from the Meteocat API inside the Home Assistant environment.
@@ -80,11 +84,32 @@ To change units select one of the entities and open the more info dialog and cli
 
 ![Entity more info settings dialog](images/change_units.png)
 
+## Options
+
+Once the integration is installed, you can reconfigure some parameters without having to remove and reinstall Meteocat.
+
+Go to:
+`Settings > Devices & Services > Meteocat > Configure`
+
+You will see three available options:
+
+- **Update API Key and limits**  
+  Allows you to change the API Key and update all API plan limits at the same time.
+
+- **Update limits only**  
+  Allows you to adjust only the API plan limits, keeping the same API Key.
+
+- **Regenerate assets**  
+  If for any reason some files in the `assets` folder (`towns.json`, `stations.json`, `variables.json`, `symbols.json`, or `stations_<town_id>.json`) are missing or outdated, you can regenerate them directly from the options menu.  
+  > ℹ️ If the Meteocat API is not available at that moment, the integration will still start, and you can retry regeneration later.
+
+![Options](images/options.png)
+
 # Contributing
 
-1.  [Check for open features/bugs](https://gitlab.com/figorr/meteocat/issues)
-    or [initiate a discussion on one](https://gitlab.com/figorr/meteocat/issues/new).
-2.  [Fork the repository](https://gitlab.com/figorr/meteocat/forks/new).
+1.  [Check for open features/bugs](https://github.com/figorr/meteocat/issues)
+    or [initiate a discussion on one](https://github.com/figorr/meteocat/issues/new/choose).
+2.  [Fork the repository](https://github.com/figorr/meteocat/fork).
 3.  Install the dev environment: `make init`.
 4.  Enter the virtual environment: `pipenv shell`
 5.  Code your new feature or bug fix.