Merge pull request #48 from BottlecapDave/develop

New release

Author: BottlecapDave

.build/createGithubRelease.ts

@@ -1,5 +1,14 @@
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
 const bodySuffix = "---\nEnjoying the integration? Why not make a one time or monthly [GitHub sponsorship](https://github.com/sponsors/bottlecapdave)?"
 
+function getMinimumHomeAssistantVersion() {
+  const hacsFilePath = join(__dirname, '../hacs.json');
+  const buffer = readFileSync(hacsFilePath);
+  const content = JSON.parse(buffer.toString());
+  return content.homeassistant;
+}
 async function createGithubRelease(githubToken: string, githubOwnerRepo: string, tag: string, notes: string) {
   if (!githubToken) {
     throw new Error('Github token not specified');
@@ -45,9 +54,10 @@ async function createGithubRelease(githubToken: string, githubOwnerRepo: string,
   }
 }
 
+const minimumHAVersionNote = `\n**Minimum HA Version**: ${getMinimumHomeAssistantVersion()}\n\n`;
 createGithubRelease(
   process.env.GITHUB_TOKEN,
   process.env.GITHUB_REPOSITORY,
   process.argv[2],
-  `${process.argv[3]}\n${bodySuffix}`
+  `${process.argv[3]}\n${minimumHAVersionNote}${bodySuffix}`
 ).then(() => console.log('Success'));

.github/workflows/main.yml

@@ -1,7 +1,7 @@
 name: Main
 on:
   schedule:
-    - cron:  '0 1 * * *'
+    - cron:  '0 6 * * *'
   push:
     branches:
       - develop

_docs/faq.md

@@ -11,9 +11,9 @@ The `ATCO code` for your stop can be found in the same way that [UK Transport](h
 
 However, there have been reports of missing ATCO codes. Therefore alternatively, you can follow the following instructions:
 
-1. Navigate to https://www.firstbus.co.uk/next-bus and type your location
+1. Navigate to [First Bus website](https://www.firstbus.co.uk/next-bus) and type your location
 2. Open up the development tools on your browser (usually F12) and go to the network tab
-3. Click on the stop that you're after and look at the network request. This should make a request to https://www.firstbus.co.uk/api/get-next-bus?stop=XXX. The value you're after will be in the response and also the value of XXX.
+3. Click on the stop that you're after and look at the network request. This should make a request to `https://www.firstbus.co.uk/api/get-next-bus?stop=XXX`. The value you're after will be in the response and also the value of XXX.
 
 ## How do I increase the logs for the integration?
 

_docs/index.md

@@ -8,6 +8,23 @@ This is unofficial and in no way endorsed by First Bus.
 
     This component uses a private API used by [First Bus website](https://www.firstbus.co.uk/next-bus), so it could break at any time. I will do my best to keep the component working.
 
+## How to install
+
+### HACS
+
+[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
+
+This integration can be installed directly via HACS. To install:
+
+* [Add the repository](https://my.home-assistant.io/redirect/hacs_repository/?owner=BottlecapDave&repository=homeassistant-firstbus&category=integration) to your HACS installation
+* Click `Download`
+
+### Manual
+
+You should take the latest [published release](https://github.com/BottlecapDave/HomeAssistant-FirstBus/releases). The current state of `develop` will be in flux and therefore possibly subject to change.
+
+To install, place the contents of `custom_components` into the `<config directory>/custom_components` folder of your Home Assistant installation. Once installed, don't forget to restart your home assistant instance for the integration to be picked up.
+
 ## How to setup
 
 Please follow the [setup guide](./setup.md) to setup your initial account. This guide details the configuration, along with the entities that will be available to you.

custom_components/first_bus/__init__.py

@@ -1,19 +1,17 @@
-import logging
 from homeassistant.util.dt import utcnow
-import asyncio
 
 from .const import (
   DOMAIN,
 )
 
+PLATFORMS = ["sensor"]
+
 async def async_setup_entry(hass, entry):
   """This is called from the config flow."""
   hass.data.setdefault(DOMAIN, {})
 
   # Forward our entry to setup our default sensors
-  hass.async_create_task(
-    hass.config_entries.async_forward_entry_setup(entry, "sensor")
-  )
+  await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
 
   return True
 
@@ -24,10 +22,6 @@ async def options_update_listener(hass, entry):
 async def async_unload_entry(hass, entry):
   """Unload a config entry."""
 
-  unload_ok = all(
-      await asyncio.gather(
-          *[hass.config_entries.async_forward_entry_unload(entry, "sensor")]
-      )
-  )
+  unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
 
   return unload_ok

custom_components/first_bus/translations/en.json

@@ -11,7 +11,7 @@
           "Buses": "Buses"
         },
         "data_description": {
-          "Stop": "Instructions to find your ATCO code can be found at https://github.com/BottlecapDave/HomeAssistant-FirstBus#atco-code",
+          "Stop": "Instructions to find your ATCO code can be found at https://bottlecapdave.github.io/HomeAssistant-FirstBus/faq/#how-do-i-find-my-atco-code",
           "Buses": "You can filter to specific buses, comma separated, or leave blank to see all buses"
         }
       }

hacs.json

@@ -1,4 +1,5 @@
 {
   "name": "First Bus",
-  "render_readme": true
+  "render_readme": true,
+  "homeassistant": "2022.8.0"
 }

package-lock.json

@@ -22,15 +22,15 @@
   },
   "homepage": "https://github.com/BottlecapDave/HomeAssistant-FirstBus#readme",
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
     "commitizen": "^4.3.0",
     "conventional-changelog-eslint": "^3.0.9",
     "cz-customizable": "^6.3.0",
     "husky": "^4.3.8",
     "semantic-release": "^22.0.5",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "typescript": "^5.2.2"
   },
   "config": {