Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump alpine base image #159

Merged
merged 7 commits into from
Jan 10, 2025
Merged

Bump alpine base image #159

merged 7 commits into from
Jan 10, 2025

Conversation

cociweb
Copy link
Collaborator

@cociweb cociweb commented Jan 10, 2025

Move alpine base image from 3.18 to latest (3.21).

It should resolve the issue #154

Summary by CodeRabbit

  • Build Configuration

    • Updated base image tags to the latest version for multiple architectures in build configuration.
    • Deleted build configuration file for the ebusd package.
  • Development

    • Added time library include in header file for potential time-related functionality.
  • Changelog

    • Restructured and updated changelog entries for improved clarity, including new features and bug fixes.
  • Documentation

    • Enhanced README with a structured support section and versioning explanation.
    • Updated version in configuration file to reflect the new release.

Move the base images from 3.18 to the latest (currently 3.21)
@cociweb cociweb requested a review from LukasGrebe January 10, 2025 13:50
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request involves modifications to various files within the ebusd project, including updates to build configurations, Dockerfile adjustments, and header file inclusions. Key changes include the removal of a build configuration file, the deletion of specific repository URLs in the Dockerfile, the addition of a time-related header in a library file, and updates to base image tags from version 3.18 to 3.21 across multiple architectures in the build.yaml file. Additionally, the changelog and README files have been restructured for clarity and usability.

Changes

File Change Summary
alpine/0001-patch.patch Added #include <time.h> to src/lib/knx/knxnet.h header
alpine/APKBUILD Removed build configuration file for ebusd package
ebusd/Dockerfile Deleted URLs for Alpine Linux package repositories
ebusd/build.yaml Updated base image tags from 3.18 to 3.21 for all architectures
ebusd/CHANGELOG.md Restructured changelog entries, updated versioning format
ebusd/README.md Restructured support section and clarified versioning scheme
ebusd/config.yaml Updated version from 24.1.0 to 24.1.1

Possibly related PRs

  • Bump eBUSd version to 24.1.0 #153: The changes in the ebusd/CHANGELOG.md and ebusd/config.yaml files involve version updates, which may relate to the overall project structure and dependencies, including the header file modifications in the main PR.

Suggested reviewers

  • cociweb
  • ajvdw

Poem

🐰 Hopping through code with glee,
Base images now run free!
Headers dance with time's embrace,
Repositories vanish without a trace.
Build configs leap to something new! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cociweb cociweb changed the title Issue154 Bump alpine base image Jan 10, 2025
@cociweb cociweb requested a review from tjorim January 10, 2025 14:00
@jabdoa2
Copy link

jabdoa2 commented Jan 10, 2025

Are you sure about latest? That would make any rebuild non-deterministic.

I would suggest usingghcr.io/home-assistant/amd64-base:3.21@sha256:d7ceecd2b9e8094ea46b39eded5a40284a764477c2d48de10dd22b46f5fe77b8 instead. This will pin to a specific image.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1094b3 and 81f479e.

📒 Files selected for processing (1)
  • ebusd/build.yaml (1 hunks)
🔇 Additional comments (1)
ebusd/build.yaml (1)

2-6: Verify architecture support in Alpine 3.21

Please ensure all listed architectures are still supported in Alpine 3.21, especially i386 which is being gradually phased out in some distributions.

Run this script to check the official Alpine release notes and verify architecture support:

✅ Verification successful

Alpine 3.21 architecture support verified

All architectures (aarch64, amd64, armhf, armv7, i386) are officially supported in Alpine 3.21. The base images can be safely updated.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check Alpine 3.21 release notes for architecture support changes

# Fetch Alpine release information
curl -s https://alpinelinux.org/releases/ | grep -A 5 "Alpine 3.21"

# Check if images exist for all architectures
architectures=("aarch64" "amd64" "armhf" "armv7" "i386")
for arch in "${architectures[@]}"; do
  echo "Checking $arch..."
  # Verify if the image exists
  crane manifest "ghcr.io/home-assistant/${arch}-base:3.21" > /dev/null
  if [ $? -eq 0 ]; then
    echo "✓ Image exists for $arch"
  else
    echo "✗ Image not found for $arch"
  fi
done

Length of output: 1728


Script:

#!/bin/bash
# Check Alpine 3.21 architecture support and image existence

# Check Alpine 3.21 releases for each architecture
echo "Checking Alpine 3.21 architecture repositories..."
architectures=("aarch64" "x86_64" "armhf" "armv7" "x86")
for arch in "${architectures[@]}"; do
  status=$(curl -s -o /dev/null -w "%{http_code}" "https://dl-cdn.alpinelinux.org/alpine/v3.21/releases/${arch}/")
  echo "${arch}: HTTP ${status}"
done

echo -e "\nChecking Home Assistant base images..."
# Check if images exist in GitHub Container Registry
for arch in "aarch64" "amd64" "armhf" "armv7" "i386"; do
  status=$(curl -s -o /dev/null -w "%{http_code}" -H "Accept: application/vnd.docker.distribution.manifest.v2+json" \
    "https://ghcr.io/v2/home-assistant/${arch}-base/manifests/3.21")
  echo "${arch}-base:3.21: HTTP ${status}"
done

Length of output: 2711

ebusd/build.yaml Show resolved Hide resolved
@LukasGrebe
Copy link
Owner

https://github.com/home-assistant/docker-base/tree/2024.12.1#base-images mentions 3.21 as latest version. i've updated the code.

As for the versioning Scheme we'll continue forwars by using pre-release identifies for addon specific changes:

i'll push another commit with this addition in the readme and changelog and config.yaml version

This add-on is versioned in a way that mirrors the ebusd version.
Addon specific iterations are denoted by a pre-release identifier (e.g., -ha-addon.1).

  • Major.Minor.Patch: Mirrors the corresponding ebusd version.
  • Pre-release Identifier: Used to denote add-on-specific iterations (e.g., -ha-addon.1).

@cociweb
Copy link
Collaborator Author

cociweb commented Jan 10, 2025

it is planned to swap the baseimage, it is just an urgent fix.

Update changelog, Readme and config.yaml
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 81f479e and 8f9a2e6.

📒 Files selected for processing (3)
  • ebusd/CHANGELOG.md (2 hunks)
  • ebusd/README.md (1 hunks)
  • ebusd/config.yaml (1 hunks)
🧰 Additional context used
🪛 LanguageTool
ebusd/README.md

[style] ~13-~13: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ... Issues in Configuration and Usage Lots of issues result from incomplete [ebusd co...

(A_LOT_OF)

ebusd/CHANGELOG.md

[uncategorized] ~33-~33: When ‘Add-on-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...Improvements * Fix semantic versioning: Add-on specific iterations are denoted by a pre-release...

(SPECIFIC_HYPHEN)


[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ...lease identifier (e.g., -ha-addon.1). ebusd version is mirrored. ### Bug Fixes * B...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[inconsistency] ~38-~38: A new year has begun. Did you mean “2025-10-27”?
Context: ...mage version from 2.18 to 3.21 # 24.1 (2024-10-27) ## [ebusd](https://github.com/john30/e...

(DATE_NEW_YEAR)


[grammar] ~55-~55: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... "write" commands * add option to allow write direction in "read" command when inline...

(ALLOW_TO_DO)

🪛 Markdownlint (0.37.0)
ebusd/README.md

14-14: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


16-16: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


30-30: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


31-31: Expected: 1; Actual: 3
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


21-21: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


18-18: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


17-17: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

ebusd/CHANGELOG.md

68-68: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


72-72: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


76-76: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


80-80: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


6-6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


12-12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


18-18: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


25-25: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


29-29: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


30-30: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


32-32: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


35-35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


40-40: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


40-40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


49-49: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


61-61: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


3-3: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


29-29: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


38-38: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


7-7: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


13-13: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


19-19: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


26-26: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


33-33: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


41-41: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


50-50: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


62-62: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


62-62: null
Bare URL used

(MD034, no-bare-urls)


131-131: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

🔇 Additional comments (6)
ebusd/config.yaml (1)

2-2: LGTM: Version update follows semantic versioning

The version update to "24.1.1-ha-addon.1" properly follows semantic versioning and clearly distinguishes add-on specific changes.

ebusd/README.md (2)

11-19: LGTM: Improved support section organization

The support section is well-organized and clearly directs users to appropriate channels for different types of issues.

🧰 Tools
🪛 LanguageTool

[style] ~13-~13: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ... Issues in Configuration and Usage Lots of issues result from incomplete [ebusd co...

(A_LOT_OF)

🪛 Markdownlint (0.37.0)

14-14: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


16-16: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


18-18: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


17-17: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


21-28: LGTM: Clear versioning scheme documentation

The versioning scheme is well-documented with clear examples and explanations.

🧰 Tools
🪛 Markdownlint (0.37.0)

21-21: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

ebusd/CHANGELOG.md (3)

1-37: LGTM: Well-structured changelog

The changelog clearly separates add-on specific changes from ebusd changes and provides good categorization of changes (Features, Improvements, Bug Fixes).

🧰 Tools
🪛 LanguageTool

[uncategorized] ~33-~33: When ‘Add-on-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...Improvements * Fix semantic versioning: Add-on specific iterations are denoted by a pre-release...

(SPECIFIC_HYPHEN)


[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ...lease identifier (e.g., -ha-addon.1). ebusd version is mirrored. ### Bug Fixes * B...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 Markdownlint (0.37.0)

3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


6-6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


12-12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


18-18: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


25-25: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


29-29: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


30-30: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


32-32: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


35-35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


3-3: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


29-29: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


7-7: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


13-13: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


19-19: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


26-26: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


33-33: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


38-38: Fix incorrect future date

The date "2024-10-27" appears to be incorrect as it's in the future (current date: January 2025).

Please verify and update the date to reflect the actual release date.

🧰 Tools
🪛 LanguageTool

[inconsistency] ~38-~38: A new year has begun. Did you mean “2025-10-27”?
Context: ...mage version from 2.18 to 3.21 # 24.1 (2024-10-27) ## [ebusd](https://github.com/john30/e...

(DATE_NEW_YEAR)

🪛 Markdownlint (0.37.0)

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


38-38: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


35-36: LGTM: Base image update properly documented

The Alpine base image update from 2.18 to 3.21 is properly documented in the changelog under Bug Fixes.

🧰 Tools
🪛 Markdownlint (0.37.0)

35-35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


36-36: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

ebusd/README.md Outdated Show resolved Hide resolved
@cociweb
Copy link
Collaborator Author

cociweb commented Jan 10, 2025

i think 24.1.1 is enough to distinguish the subversions and addon versions.

ebusd_main_version.ebusd_major_version.addon_subversion

its totally identificable in my opinion:

the
Major.Minor.Patch: versioning strategy of ebusd was dropped with v2.0 in 2016.

later on, we can add development tag/pre release to separate the interim releases.

@LukasGrebe
Copy link
Owner

LukasGrebe commented Jan 10, 2025

without pre-release identifiers, we couldnt update to an ebusd release 24.1.1 once we created a 24.1.1 or we would need to artificially bump to a non-exsiting 24.1.2 which again would create problems when theres an official 24.1.2 release.

@cociweb
Copy link
Collaborator Author

cociweb commented Jan 10, 2025

without pre-release identifiers, we couldnt update to an ebusd release 24.1.1 once we created a 24.1.1 or we would need to artificially bump to a non-exsiting 24.1.2 which again would create problems when theres an official 24.1.2 release.

I think when an upstream patch is released (we can increase the version of the addon - as soon as we include it.) it won't contain any new features so there will be no change in the main.major version. (never happened earlier on the released upstream sw.). In my experience X.X.Patchversion is only applied in the nigthly builds.

Although we've never bumped to patch version.

@LukasGrebe
Copy link
Owner

pretty sure @tjorim is inactive in this project

@cociweb
Copy link
Collaborator Author

cociweb commented Jan 10, 2025

but if we would like to insist to the upstream Major.Minor.Patch versioning strategy then maybe we can adjust our stratagy as Major.Minor.Patch.addon. eg:
24.1.0.1

This versioning strategy is also very common as well. but there is a change we will have many X.X.0.X versions. :)

@LukasGrebe
Copy link
Owner

Goodpoint - and i havnt seen a patch version from ebusd yet.

as per discussion - use the patch number for addon specific changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
ebusd/CHANGELOG.md (1)

Line range hint 1-134: Improve markdown formatting consistency.

Please address the following formatting issues:

  1. Use consistent list item markers (asterisks instead of dashes)
  2. Add blank lines around headings and lists
  3. Fix trailing spaces
  4. Remove multiple consecutive blank lines
🧰 Tools
🪛 LanguageTool

[uncategorized] ~7-~7: When ‘Add-on-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... versioning: ebusd version is mirrored; Add-on specific iterations are denoted by the patch num...

(SPECIFIC_HYPHEN)


[inconsistency] ~12-~12: A new year has begun. Did you mean “2025-10-27”?
Context: ...mage version from 2.18 to 3.21 # 24.1 (2024-10-27) ## [ebusd](https://github.com/john30/e...

(DATE_NEW_YEAR)


[grammar] ~29-~29: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... "write" commands * add option to allow write direction in "read" command when inline...

(ALLOW_TO_DO)


[grammar] ~87-~87: The word ‘install’ is not a noun.
Context: ...ld containers. This should speed up the install of the addon as the addon does not need...

(A_INSTALL)

🪛 Markdownlint (0.37.0)

71-71: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


75-75: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


79-79: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


83-83: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


87-87: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


88-88: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


7-7: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


40-40: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


6-6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


9-9: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


12-12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


13-13: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


13-13: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


23-23: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


35-35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


41-41: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


42-42: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


44-44: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


50-50: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


55-55: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


56-56: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


56-56: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


63-63: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


3-3: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


12-12: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


41-41: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


67-67: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


7-7: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


10-10: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


15-15: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


24-24: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


45-45: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


51-51: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


57-57: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


64-64: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e80107 and c13278d.

📒 Files selected for processing (3)
  • ebusd/CHANGELOG.md (2 hunks)
  • ebusd/README.md (1 hunks)
  • ebusd/config.yaml (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
ebusd/README.md

14-14: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


17-17: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


25-25: Element: ebusd
Inline HTML

(MD033, no-inline-html)


25-25: Element: ebusd
Inline HTML

(MD033, no-inline-html)


25-25: Element: Addon-specific
Inline HTML

(MD033, no-inline-html)


16-16: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


25-25: null
Spaces inside emphasis markers

(MD037, no-space-in-emphasis)

ebusd/CHANGELOG.md

71-71: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


75-75: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


79-79: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


83-83: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


7-7: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


40-40: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


3-3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


4-4: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


6-6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


9-9: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


12-12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


13-13: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


13-13: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


14-14: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


23-23: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


35-35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


41-41: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


42-42: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


44-44: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


50-50: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


55-55: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


56-56: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


56-56: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


63-63: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


3-3: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


12-12: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


41-41: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


67-67: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


7-7: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


10-10: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


15-15: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


24-24: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


45-45: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


51-51: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


57-57: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


64-64: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


36-36: null
Bare URL used

(MD034, no-bare-urls)


134-134: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)

🪛 LanguageTool
ebusd/README.md

[uncategorized] ~25-~25: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...). while the Addon-specific Iteration denote add-on-specific iterations. *Example...

(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)

ebusd/CHANGELOG.md

[uncategorized] ~7-~7: When ‘Add-on-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... versioning: ebusd version is mirrored; Add-on specific iterations are denoted by the patch num...

(SPECIFIC_HYPHEN)


[inconsistency] ~12-~12: A new year has begun. Did you mean “2025-10-27”?
Context: ...mage version from 2.18 to 3.21 # 24.1 (2024-10-27) ## [ebusd](https://github.com/john30/e...

(DATE_NEW_YEAR)


[grammar] ~29-~29: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... "write" commands * add option to allow write direction in "read" command when inline...

(ALLOW_TO_DO)

🔇 Additional comments (3)
ebusd/config.yaml (1)

2-2: LGTM! Version bump follows semantic versioning.

The version increment from "24.1.0" to "24.1.1" properly reflects the Alpine base image update as a patch-level change.

ebusd/README.md (1)

11-18: LGTM! Clear support section structure.

The new support section effectively guides users to the appropriate channels for different types of issues.

🧰 Tools
🪛 Markdownlint (0.37.0)

14-14: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


17-17: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


16-16: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

ebusd/CHANGELOG.md (1)

9-10: LGTM! Clear documentation of Alpine base image update.

The changelog properly documents the bump of Home Assistant base image version from 3.18 to 3.21.

🧰 Tools
🪛 Markdownlint (0.37.0)

9-9: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


10-10: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

ebusd/README.md Show resolved Hide resolved
@LukasGrebe LukasGrebe merged commit 1abaae5 into main Jan 10, 2025
12 checks passed
@LukasGrebe LukasGrebe deleted the issue154 branch January 10, 2025 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants