Refactoring and renaming add-ons to apps #219
Conversation
frenck
added
refactor
WalkthroughThis pull request rebadges the project from "Add-on" to "App" across docs, examples, Docker labels, and scripts; upgrades the Code of Conduct to Contributor Covenant 3.0; adds top-level permissions and updates reusable workflow references to pinned commits; and bumps copyright years to 2026. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~30 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
frenck
changed the title
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In @.github/CONTRIBUTING.md:
- Around line 28-29: The CONTRIBUTING.md link references ([github], [prs]) point
to a non-existent repository (app-example) causing 404s; update the URL targets
used by the link labels ([github], [prs]) to the existing addon-example
repository (use https://github.com/hassio-addons/addon-example and the
corresponding /issues and /pulls paths) or restore the original addon-example
links so the links resolve correctly; locate the link definitions for [github]
and [prs] in the file and replace the app-example URLs with the addon-example
equivalents (or adjust to the correct repo if you create/rename app-example).
In @.github/workflows/ci.yaml:
- Around line 22-23: Replace the floating ref "@main" in the reusable workflow
invocation (the string
"hassio-addons/workflows/.github/workflows/app-ci.yaml@main") with an immutable
pinned ref (preferably a full commit SHA or a fixed tag) so CI uses a specific
upstream revision; update the workflow to reference that SHA/tag and
document/update it via deliberate PRs when you want to move to a newer upstream
version.
In `@example/config.yaml`:
- Around line 5-6: The URL in the config.yaml's url field is broken; open the
file, locate the url key (next to the description key) and replace the existing
value "https://github.com/hassio-addons/app-example" with the verified correct
GitHub repository URL for this app (or remove/disable the link if no repository
exists), ensuring the url value is a valid reachable HTTPS GitHub repo.
In `@example/DOCS.md`:
- Around line 34-35: Replace the typo "Eventought" with "Even though" in the
DOCS.md introduction sentence (the string "Eventought this app is just an
example app, it does come with some configuration options to play around with.")
so the line reads "Even though this app is just an example app, it does come
with some configuration options to play around with."
| [github]: https://github.com/hassio-addons/app-example/issues | ||
| [prs]: https://github.com/hassio-addons/app-example/pulls |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the GitHub repository URLs are accessible
echo "Testing app-example repository base URL:"
curl -s -o /dev/null -w "Status: %{http_code}\n" "https://github.com/hassio-addons/app-example"
echo "Testing issues endpoint:"
curl -s -o /dev/null -w "Status: %{http_code}\n" "https://github.com/hassio-addons/app-example/issues"
echo "Testing pulls endpoint:"
curl -s -o /dev/null -w "Status: %{http_code}\n" "https://github.com/hassio-addons/app-example/pulls"
# Also test if the old addon-example still exists for comparison
echo "Testing old addon-example repository (for reference):"
curl -s -o /dev/null -w "Status: %{http_code}\n" "https://github.com/hassio-addons/addon-example"Repository: hassio-addons/addon-example
Length of output: 262
Do not merge: The new repository URLs are not accessible (404).
The app-example repository does not exist. All three URLs return HTTP 404:
- https://github.com/hassio-addons/app-example (base)
- https://github.com/hassio-addons/app-example/issues
- https://github.com/hassio-addons/app-example/pulls
The old addon-example repository is still live and accessible (HTTP 200). Either rename/create the app-example repository before merging, or revert these URLs to point to addon-example.
🤖 Prompt for AI Agents
In @.github/CONTRIBUTING.md around lines 28 - 29, The CONTRIBUTING.md link
references ([github], [prs]) point to a non-existent repository (app-example)
causing 404s; update the URL targets used by the link labels ([github], [prs])
to the existing addon-example repository (use
https://github.com/hassio-addons/addon-example and the corresponding /issues and
/pulls paths) or restore the original addon-example links so the links resolve
correctly; locate the link definitions for [github] and [prs] in the file and
replace the app-example URLs with the addon-example equivalents (or adjust to
the correct repo if you create/rename app-example).
| description: Example app by Home Assistant Community Apps | ||
| url: https://github.com/hassio-addons/app-example |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the GitHub repo URL resolves
curl -s -o /dev/null -w "%{http_code}\n" -I https://github.com/hassio-addons/app-exampleRepository: hassio-addons/addon-example
Length of output: 74
Fix broken GitHub repository URL.
The URL https://github.com/hassio-addons/app-example returns HTTP 404 and does not exist. Verify the correct repository name and update the URL accordingly.
🤖 Prompt for AI Agents
In `@example/config.yaml` around lines 5 - 6, The URL in the config.yaml's url
field is broken; open the file, locate the url key (next to the description key)
and replace the existing value "https://github.com/hassio-addons/app-example"
with the verified correct GitHub repository URL for this app (or remove/disable
the link if no repository exists), ensuring the url value is a valid reachable
HTTPS GitHub repo.
| Eventought this app is just an example app, it does come with some | ||
| configuration options to play around with. |
There was a problem hiding this comment.
Fix typo in configuration intro.
Line 34 reads “Eventought” → “Even though”.
Proposed fix
-Eventought this app is just an example app, it does come with some
+Even though this app is just an example app, it does come with some📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Eventought this app is just an example app, it does come with some | |
| configuration options to play around with. | |
| Even though this app is just an example app, it does come with some | |
| configuration options to play around with. |
🤖 Prompt for AI Agents
In `@example/DOCS.md` around lines 34 - 35, Replace the typo "Eventought" with
"Even though" in the DOCS.md introduction sentence (the string "Eventought this
app is just an example app, it does come with some configuration options to play
around with.") so the line reads "Even though this app is just an example app,
it does come with some configuration options to play around with."
Proposed Changes
Happy New Year 🥂
This PR refactors the general add-on structure a bit, most notably renaming the add-on naming to apps (following Home Assistant's naming change).
This PR also updates for the upstream workflow changes and improvements.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.