Fix version format for development build

[ludeeus]

Home Assistant does not allow custom integrations to have version numbers like 1.34.1.devb4fe3fe 🙈

[coderabbitai]

Walkthrough

Walkthrough

In version 1.1.1, modifications addressed the version format for development builds. The changes include renaming a utility function in the codebase and updating a script to adjust how version strings are constructed by appending a -dev- prefix followed by the short git commit hash.

Changes

File	Change Summary
get/CHANGELOG.md	Documented the fix to the version format for development builds.
src/versionUtils.js	Renamed getVersionFormat() to getVersionFormatForDevBuilds().
get/rootfs/etc/addon/run	Updated the version string formation to include -dev- prefix before appending the git commit hash.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between f33085f and 4d3f057.

Files selected for processing (2)

• get/CHANGELOG.md (1 hunks)
• get/rootfs/etc/addon/run (1 hunks)

Additional context used

Markdownlint

get/CHANGELOG.md

5-5: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

---

10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

Additional comments not posted (1)

get/rootfs/etc/addon/run (1)

33-33: Version format change approved.

The change from .dev suffix to -dev- prefix in the version format is crucial for compliance with Home Assistant's requirements. Ensure this new format is consistently used wherever version formatting is required.

Verification successful

---

Version format change approved.

The new version format -dev- is correctly implemented in the specified location, and no instances of the old .dev format were found in the codebase. This ensures compliance with the new requirements.

• Location verified:
  • get/rootfs/etc/addon/run

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify that the new version format is used consistently across the system.

# Test: Search for the old and new version formats. Expect: Only occurrences of the new format.
rg --type sh $'\.dev'
rg --type sh $'-dev-'

Length of output: 597

---

---

Script:

#!/bin/bash
# Description: Verify that the new version format is used consistently across the system.

# Test: Search for the old and new version formats. Expect: Only occurrences of the new format.

# Corrected command to search for the old format
rg --type sh '\.dev'

# Corrected command to search for the new format
rg --type sh '\-dev\-'

Length of output: 345

---

---

Script:

#!/bin/bash
# Description: Verify that the new version format is used consistently across the system.

# Test: Search for the old and new version formats. Expect: Only occurrences of the new format.

# Remove type filter to search all files
rg '\.dev'
rg '\-dev\-'

Length of output: 177

---

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

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range comments (1)

get/CHANGELOG.md (1)

Line range hint 1-10: Restructure document to use a single top-level heading.

The markdown file should ideally have only one top-level heading to maintain a clear structure. Consider using secondary headings for subsequent versions.

-# 1.1.1
+## 1.1.1
-# 1.1.0
+## 1.1.0

Tools

Markdownlint

5-5: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

[frenck]

Thanks, @ludeeus 👍

../Frenck