Skip to content

Commit 86cb836

Browse files
saironsairon
authored
Rename add-on to app, update base image (#129)
1 parent 8d5765c commit 86cb836

14 files changed

Lines changed: 56 additions & 52 deletions

File tree

‎.github/workflows/builder.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ jobs:
2727
id: changed_files
2828
uses: jitterbit/get-changed-files@v1
2929

30-
- name: Find add-on directories
30+
- name: Find app directories
3131
id: addons
3232
uses: home-assistant/actions/helpers/find-addons@master
3333

34-
- name: Get changed add-ons
34+
- name: Get changed apps
3535
id: changed_addons
3636
run: |
3737
declare -a changed_addons
@@ -50,17 +50,17 @@ jobs:
5050
changed=$(echo ${changed_addons[@]} | rev | cut -c 2- | rev)
5151
5252
if [[ -n ${changed} ]]; then
53-
echo "Changed add-ons: $changed";
53+
echo "Changed apps: $changed";
5454
echo "changed=true" >> $GITHUB_OUTPUT;
5555
echo "addons=[$changed]" >> $GITHUB_OUTPUT;
5656
else
57-
echo "No add-on had any monitored files changed (${{ env.MONITORED_FILES }})";
57+
echo "No app had any monitored files changed (${{ env.MONITORED_FILES }})";
5858
fi
5959
build:
6060
needs: init
6161
runs-on: ubuntu-latest
6262
if: needs.init.outputs.changed == 'true'
63-
name: Build ${{ matrix.arch }} ${{ matrix.addon }} add-on
63+
name: Build ${{ matrix.arch }} ${{ matrix.addon }} app
6464
strategy:
6565
matrix:
6666
addon: ${{ fromJson(needs.init.outputs.changed_addons) }}
@@ -79,7 +79,7 @@ jobs:
7979
with:
8080
path: "./${{ matrix.addon }}"
8181

82-
- name: Check if add-on should be built
82+
- name: Check if app should be built
8383
id: check
8484
run: |
8585
if [[ "${{ steps.info.outputs.image }}" == "null" ]]; then
@@ -104,7 +104,7 @@ jobs:
104104
username: ${{ github.repository_owner }}
105105
password: ${{ secrets.GITHUB_TOKEN }}
106106

107-
- name: Build ${{ matrix.addon }} add-on
107+
- name: Build ${{ matrix.addon }} app
108108
if: steps.check.outputs.build_arch == 'true'
109109
uses: home-assistant/builder@2026.02.1
110110
with:

‎.github/workflows/lint.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ on:
1212

1313
jobs:
1414
find:
15-
name: Find add-ons
15+
name: Find apps
1616
runs-on: ubuntu-latest
1717
outputs:
1818
addons: ${{ steps.addons.outputs.addons_list }}
1919
steps:
2020
- name: ⤵️ Check out code from GitHub
2121
uses: actions/checkout@v6.0.2
2222

23-
- name: 🔍 Find add-on directories
23+
- name: 🔍 Find app directories
2424
id: addons
2525
uses: home-assistant/actions/helpers/find-addons@master
2626

2727
lint:
28-
name: Lint add-on ${{ matrix.path }}
28+
name: Lint app ${{ matrix.path }}
2929
runs-on: ubuntu-latest
3030
needs: find
3131
strategy:
@@ -35,7 +35,7 @@ jobs:
3535
- name: ⤵️ Check out code from GitHub
3636
uses: actions/checkout@v6.0.2
3737

38-
- name: 🚀 Run Home Assistant Add-on Lint
38+
- name: 🚀 Run Home Assistant App Lint
3939
uses: frenck/action-addon-linter@v2.21
4040
with:
4141
path: "./${{ matrix.path }}"

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
# Example Home Assistant add-on repository
1+
# Example Home Assistant app repository
22

3-
This repository can be used as a "blueprint" for add-on development to help you get started.
3+
This repository can be used as a "blueprint" for app development to help you get started.
44

5-
Add-on documentation: <https://developers.home-assistant.io/docs/add-ons>
5+
Apps documentation: <https://developers.home-assistant.io/docs/apps>
66

7-
[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhome-assistant%2Faddons-example)
7+
[![Open your Home Assistant instance and show the app store with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_store.svg)](https://my.home-assistant.io/redirect/supervisor_store/?repository_url=https%3A%2F%2Fgithub.com%2Fhome-assistant%2Fapps-example)
88

9-
## Add-ons
9+
## Apps
1010

11-
This repository contains the following add-ons
11+
This repository contains the following apps
1212

13-
### [Example add-on](./example)
13+
### [Example app](./example)
1414

1515
![Supports aarch64 Architecture][aarch64-shield]
1616
![Supports amd64 Architecture][amd64-shield]
1717

18-
_Example add-on to use as a blueprint for new add-ons._
18+
_Example app to use as a blueprint for new apps._
1919

2020
<!--
2121
2222
Notes to developers after forking or using the github template feature:
23-
- While developing comment out the 'image' key from 'example/config.yaml' to make the supervisor build the addon
23+
- While developing comment out the 'image' key from 'example/config.yaml' to make the supervisor build the app
2424
- Remember to put this back when pushing up your changes.
2525
- When you merge to the 'main' branch of your repository a new build will be triggered.
2626
- Make sure you adjust the 'version' key in 'example/config.yaml' when you do that.
2727
- Make sure you update 'example/CHANGELOG.md' when you do that.
2828
- The first time this runs you might need to adjust the image configuration on github container registry to make it public
29-
- You may also need to adjust the github Actions configuration (Settings > Actions > General > Workflow > Read & Write)
29+
- You may also need to adjust the GitHub Actions configuration (Settings > Actions > General > Workflow > Read & Write)
3030
- Adjust the 'image' key in 'example/config.yaml' so it points to your username instead of 'home-assistant'.
3131
- This is where the build images will be published to.
3232
- Rename the example directory.

‎example/CHANGELOG.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
<!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
1+
<!-- https://developers.home-assistant.io/docs/apps/presentation#keeping-a-changelog -->
2+
## 1.3.0
3+
4+
- Updated to Alpine 3.23 base image.
5+
- Renamed from "add-on" to "app".
26

37
## 1.2.0
48

‎example/DOCS.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Home Assistant Add-on: Example add-on
1+
# Home Assistant App: Example app
22

33
## How to use
44

5-
This add-on really does nothing. It is just an example.
5+
This app really does nothing. It is just an example.
66

77
When started it will print the configured message or "Hello world" in the log.
88

9-
It will also print "All done!" in `/share/example_addon_output.txt` to show
10-
simple example of the usage of `map` in addon config.
9+
It will also print "All done!" in `/share/example_app_output.txt` to show
10+
simple example of the usage of `map` in app config.

‎example/Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile
1+
# https://developers.home-assistant.io/docs/apps/configuration#app-dockerfile
22
ARG BUILD_FROM
33
FROM $BUILD_FROM
44

‎example/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Home Assistant Add-on: Example add-on
1+
# Home Assistant App: Example app
22

3-
_Example add-on to use as a blueprint for new add-ons._
3+
_Example app to use as a blueprint for new apps._
44

55
![Supports aarch64 Architecture][aarch64-shield]
66
![Supports amd64 Architecture][amd64-shield]

‎example/apparmor.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ profile example flags=(attach_disconnected,mediate_deleted) {
2424
/usr/lib/bashio/** ix,
2525
/tmp/** rwk,
2626

27-
# Access to options.json and other files within your addon
27+
# Access to options.json and other files within your app
2828
/data/** rw,
2929

3030
# Start new profile for service
@@ -36,7 +36,7 @@ profile example flags=(attach_disconnected,mediate_deleted) {
3636
# Receive signals from S6-Overlay
3737
signal (receive) peer=*_example,
3838

39-
# Access to options.json and other files within your addon
39+
# Access to options.json and other files within your app
4040
/data/** rw,
4141

4242
# Access to mapped volumes specified in config.json
@@ -45,7 +45,7 @@ profile example flags=(attach_disconnected,mediate_deleted) {
4545
# Access required for service functionality
4646
# Note: List was built by doing the following:
4747
# 1. Add what is obviously needed based on what is in the script
48-
# 2. Add `complain` as a flag to this profile temporarily and run the addon
48+
# 2. Add `complain` as a flag to this profile temporarily and run the app
4949
# 3. Review the audit log with `journalctl _TRANSPORT="audit" -g 'apparmor="ALLOWED"'` and add other access as needed
5050
# Remember to remove the `complain` flag when you are done
5151
/usr/bin/my_program r,
@@ -54,4 +54,4 @@ profile example flags=(attach_disconnected,mediate_deleted) {
5454
/etc/passwd r,
5555
/dev/tty rw,
5656
}
57-
}
57+
}

‎example/build.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile
1+
# https://developers.home-assistant.io/docs/apps/configuration#app-dockerfile
22
build_from:
3-
aarch64: "ghcr.io/home-assistant/aarch64-base:3.15"
4-
amd64: "ghcr.io/home-assistant/amd64-base:3.15"
3+
aarch64: "ghcr.io/home-assistant/aarch64-base:3.23"
4+
amd64: "ghcr.io/home-assistant/amd64-base:3.23"
55
labels:
6-
org.opencontainers.image.title: "Home Assistant Add-on: Example add-on"
7-
org.opencontainers.image.description: "Example add-on to use as a blueprint for new add-ons."
8-
org.opencontainers.image.source: "https://github.com/home-assistant/addons-example"
6+
org.opencontainers.image.title: "Home Assistant App: Example app"
7+
org.opencontainers.image.description: "Example app to use as a blueprint for new apps."
8+
org.opencontainers.image.source: "https://github.com/home-assistant/apps-example"
99
org.opencontainers.image.licenses: "Apache License 2.0"
1010
args:
1111
TEMPIO_VERSION: "2021.09.0"

‎example/config.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-config
2-
name: Example add-on
3-
version: "1.2.0"
1+
# https://developers.home-assistant.io/docs/apps/configuration#app-configuration
2+
name: Example app
3+
version: "1.3.0"
44
slug: example
5-
description: Example add-on
6-
url: "https://github.com/home-assistant/addons-example/tree/main/example"
5+
description: Example app
6+
url: "https://github.com/home-assistant/apps-example/tree/main/example"
77
arch:
88
- aarch64
99
- amd64
@@ -14,4 +14,4 @@ options:
1414
message: "Hello world..."
1515
schema:
1616
message: "str?"
17-
image: "ghcr.io/home-assistant/{arch}-addon-example"
17+
image: "ghcr.io/home-assistant/{arch}-app-example"

0 commit comments

Comments
 (0)