Skip to content

Commit

Permalink
Fix Semantic Versioning
Browse files Browse the repository at this point in the history
Update changelog, Readme and config.yaml
  • Loading branch information
LukasGrebe committed Jan 10, 2025
1 parent 81f479e commit 8f9a2e6
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 17 deletions.
84 changes: 71 additions & 13 deletions ebusd/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,85 @@
<!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
## version: 24.1.0

- EBUSd 24.1

## version: 23.2.6
# Changelog

# next (tbd)
## Home Assistant Add-on

### Features
* Add Home Assistant Ingress (Web UI) [#147](https://github.com/LukasGrebe/ha-addons/issues/147)
* Colorize Logo to identify Add-on as running in Home Assistant [#81](https://github.com/LukasGrebe/ha-addons/issues/81)
* Easier custom MQTT device configuration [#162](https://github.com/LukasGrebe/ha-addons/issues/162)
* Include configuration files with Add-on Backups by following [HA Changes](https://developers.home-assistant.io/blog/2023/11/06/public-addon-config/) [#160](https://github.com/LukasGrebe/ha-addons/issues/160)

### Improvements
* Drastically reduce Settings UI [#85](https://github.com/LukasGrebe/ha-addons/issues/85)
* Increase security classification by creating an apparmor profile [#83](https://github.com/LukasGrebe/ha-addons/issues/83)
* Update documentation [#146](https://github.com/LukasGrebe/ha-addons/issues/146)

## [ebusd](https://github.com/john30/ebusd/blob/master/ChangeLog.md)
### Bug Fixes
* fix for device string symlink with colon
* fix "read" and "write" command response
* fix dump of divisor
* fix max value for S3N, S3N, SLG, and SLR types
* fix socket options for KNXnet/IP integration

### Features
* add "-m" option to "encode" and "decode" commands
* add output for commands executed with "--inject=stop"

# 24.1.1-ha-addon.1
## Home Assistant Add-on

### Improvements
* Fix semantic versioning: Add-on specific iterations are denoted by a pre-release identifier (e.g., `-ha-addon.1`). ebusd version is mirrored.

### Bug Fixes
* Bump Home Assistant base image version from 2.18 to 3.21

# 24.1 (2024-10-27)
## [ebusd](https://github.com/john30/ebusd/blob/master/ChangeLog.md)
### Bug Fixes
* fix conditional messages not being sent to message definition in MQTT integration and not being used in KNX group association
* fix CSV dump of config files on command line
* fix DTM type with recent dates
* fix for some updated messages not appearing on KNX or MQTT
* fix for parsing certain condition ranges
* fix for "reload" command not starting the scan again
* fix datetime type mapping in MQTT

### Features
* add "inject" command
* add config path to verbose "info" command
* add "answer" command
* add option to inject start-up commands
* add verbose raw data option to "read" and "write" commands
* add option to allow write direction in "read" command when inline defining a new message
* add option to discover device via mDNS
* add dedicated log level for device messages
* add option to extend MQTT variables from env/cmdline
* add date+datetime mapping, better device update check, and remove single-field-message field names in Home Assistant MQTT discovery integration

### Breaking Changes
* change default config path to https://ebus.github.io/ serving files generated from new TypeSpec message definition sources
* change validation of identifiers to no longer accept unusual characters
* change default device connection to be resolved automatically via mDNS

## 23.2.6

- Update HEALTHCHECK in Dockerfile to not use DNS [#126](https://github.com/LukasGrebe/ha-addons/issues/126) thanks @StCyr

## version: 23.2.5
## 23.2.5

- Revert required mode [#116](https://github.com/LukasGrebe/ha-addons/issues/116) thanks @tjorim

## version: 23.2.4
## 23.2.4

- added the option to store rotated logs in /config through s6-log [#102](https://github.com/LukasGrebe/ha-addons/issues/102) thanks @pvyleta

## version: 23.2.3
## 23.2.3

- fix Healthcheck. This should solve [#61](https://github.com/LukasGrebe/ha-addons/issues/61) thanks @cociweb

## version: 23.2.0
## 23.2.0

- Change build process to use pre-build containers. This should speed up the install of the addon as the addon does not need to be compiled from Supervisor before beeing run.
- EBUSd 23.2
Expand Down Expand Up @@ -68,9 +128,7 @@
- IMPROVE: Add mqtttopic option
- IMPROVE: Add mqttvar option
- IMPROVE: Enable MQTT discovery by default
- IMPROVE: Align version number with eBUSd version

## 0.87
- IMPROVE: Align umber with eBUSd ## 0.87

- IMPROVE: Add poll interval option
- IMPROVE: Improve option descriptions
Expand Down
24 changes: 21 additions & 3 deletions ebusd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,27 @@ See [repository readme](https://github.com/LukasGrebe/ha-addons#how-to-install)

See [docs](https://github.com/LukasGrebe/ha-addons/blob/main/ebusd/DOCS.md#how-to-run-ebusd) on how to run ebusd in supervisor.

**If you have questions or feedback please**
- via the [Home Assistant Forums Topic](https://community.home-assistant.io/t/an-ebusd-add-on/344852)
- via Issues and pull requests in the Github repository
## Support

**Issues in Configuration and Usage**
Lots of issues result from incomplete [ebusd configuration](https://github.com/john30/ebusd/wiki/4.-Configuration) files. This project only runs ebusd, configurationfiles are **not** managed by this project. Please see the offical [ebusd project](https://ebusd.eu) and [community](https://github.com/john30/ebusd/discussions) for more information.


**If you have questions or feedback on running ebusd via supervisor**
- use [Issues](https://github.com/LukasGrebe/ha-addons/issues) and [pull requests](https://github.com/LukasGrebe/ha-addons/pulls) in the Github repository
- alternativly - but not checked as often - the [Home Assistant Forums Topic](https://community.home-assistant.io/t/an-ebusd-add-on/344852)

## Versioning Scheme
This add-on is versioned in a way that [mirrors the `ebusd` version](https://github.com/john30/ebusd/releases).
Addon specific iterations are denoted by a pre-release identifier (e.g., `-ha-addon.1`).

- **Major.Minor.Patch**: Mirrors the [corresponding `ebusd` version](https://github.com/john30/ebusd/releases).
- **Pre-release Identifier**: Used to denote add-on-specific iterations (e.g., `-ha-addon.1`).

**Example**: `24.1.1-ha-addon.1`




*Not actually tested on any of these architectures*
![Supports aarch64 Architecture][aarch64-shield]
Expand Down
2 changes: 1 addition & 1 deletion ebusd/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: eBUSd

Check warning on line 1 in ebusd/config.yaml

View workflow job for this annotation

GitHub Actions / Lint add-on ebusd

'map' contains the 'config' folder, which has been replaced by 'homeassistant_config'. See: https://developers.home-assistant.io/blog/2023/11/06/public-addon-config
version: "24.1.0"
version: "24.1.1-ha-addon.1"
slug: ebusd
description: >
This Add-on runs eBUSd, a daemon for handling communication with eBUS devices
Expand Down

0 comments on commit 8f9a2e6

Please sign in to comment.