Add Version + Release action (#11)

Co-authored-by: Joakim Sørensen <[email protected]>

Author: edenhaus

.github/workflows/hassfest.yaml

@@ -0,0 +1,16 @@
+name: Validate with hassfest
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v2"
+      - uses: home-assistant/actions/hassfest@master

.github/workflows/release.yaml

@@ -0,0 +1,61 @@
+# This GitHub action workflow is meant to be copyable to any repo that have the same structure.
+# - Your integration exist under custom_components/{INTEGRATION_NAME}/[integration files]
+# - You are using GitHub releases to publish new versions
+# - You have a INTEGRATION_VERSION constant in custom_components/{INTEGRATION_NAME}/const.py
+
+name: Release Workflow
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: 🔢 Get release version
+        id: version
+        uses: home-assistant/actions/helpers/version@master
+
+      - name: ℹ️ Get integration information
+        id: information
+        run: |
+          name=$(find custom_components/ -type d -maxdepth 1 | tail -n 1 | cut -d "/" -f2)
+          echo "::set-output name=name::$name"
+      - name: 🖊️ Set version number
+        run: |
+          sed -i '/INTEGRATION_VERSION = /c\INTEGRATION_VERSION = "${{ steps.version.outputs.version }}"' \
+            "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py"
+          jq '.version = "${{ steps.version.outputs.version }}"' \
+            "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json" > tmp \
+            && mv -f tmp "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json"
+      - name: 👀 Validate data
+        run: |
+          if ! grep -q 'INTEGRATION_VERSION = "${{ steps.version.outputs.version }}"' ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py; then
+            echo "The version in custom_components/${{ steps.information.outputs.name }}/const.py was not correct"
+            cat ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/const.py | grep INTEGRATION_VERSION
+            exit 1
+          fi
+          manifestversion=$(jq -r '.version' ${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/manifest.json)
+          if [ "$manifestversion" != "${{ steps.version.outputs.version }}" ]; then
+            echo "The version in custom_components/${{ steps.information.outputs.name }}/manifest.json was not correct"
+            echo "$manifestversion"
+            exit 1
+          fi
+      - name: 📦 Create zip file for the integration
+        run: |
+          cd "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}"
+          zip ${{ steps.information.outputs.name }}.zip -r ./
+      - name: 📤 Upload the zip file as a release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ github.event.release.upload_url }}
+          asset_path: "${{ github.workspace }}/custom_components/${{ steps.information.outputs.name }}/${{ steps.information.outputs.name }}.zip"
+          asset_name: ${{ steps.information.outputs.name }}.zip
+          asset_content_type: application/zip

custom_components/readme/__init__.py

@@ -18,7 +18,7 @@
 from integrationhelper import Logger
 from integrationhelper.const import CC_STARTUP_VERSION
 
-from .const import DOMAIN_DATA, DOMAIN, ISSUE_URL, REQUIRED_FILES, VERSION
+from .const import DOMAIN_DATA, DOMAIN, ISSUE_URL, REQUIRED_FILES, INTEGRATION_VERSION
 
 CONFIG_SCHEMA = vol.Schema(
     {DOMAIN: vol.Schema({vol.Optional("convert_lovelace"): cv.boolean})},
@@ -41,7 +41,7 @@ async def async_setup(hass, config):
     # Print startup message
     Logger("custom_components.readme").info(
         CC_STARTUP_VERSION.format(
-            name=DOMAIN.capitalize(), version=VERSION, issue_link=ISSUE_URL
+            name=DOMAIN.capitalize(), version=INTEGRATION_VERSION, issue_link=ISSUE_URL
         )
     )
 
@@ -79,7 +79,7 @@ async def async_setup_entry(hass, config_entry):
     # Print startup message
     Logger("custom_components.readme").info(
         CC_STARTUP_VERSION.format(
-            name=DOMAIN.capitalize(), version=VERSION, issue_link=ISSUE_URL
+            name=DOMAIN.capitalize(), version=INTEGRATION_VERSION, issue_link=ISSUE_URL
         )
     )
 

custom_components/readme/const.py

@@ -2,7 +2,7 @@
 # Base component constants
 DOMAIN = "readme"
 DOMAIN_DATA = f"{DOMAIN}_data"
-VERSION = "0.2.1"
+INTEGRATION_VERSION = "0.0.0"
 REQUIRED_FILES = [
     "translations/en.json",
     "const.py",

custom_components/readme/manifest.json

@@ -1,7 +1,9 @@
 {
   "domain": "readme",
   "name": "Generate readme",
+  "version": "0.0.0",
   "documentation": "https://github.com/custom-components/readme",
+  "issue_tracker": "https://github.com/custom-components/issues",
   "dependencies": [],
   "config_flow": true,
   "codeowners": [
@@ -10,5 +12,5 @@
   "requirements": [
     "integrationhelper==0.2.2"
   ],
-  "homeassistant": "0.97.0"
-}
+  "iot_class": "calculated"
+}

custom_components/readme/translations/en.json

@@ -1,6 +1,5 @@
 {
     "config": {
-        "title": "Generate readme",
         "step": {
             "user": {
                 "title": "Generate readme",

hacs.json

@@ -0,0 +1,7 @@
+{
+  "name": "Generate readme",
+  "iot_class": "calculated",
+  "zip_release": true,
+  "filename": "readme.zip",
+  "hide_default_branch": true
+}