diff --git a/.github/workflows/builder.yaml b/.github/workflows/builder.yaml index f4b7c769..cef45c92 100644 --- a/.github/workflows/builder.yaml +++ b/.github/workflows/builder.yaml @@ -27,11 +27,11 @@ jobs: id: changed_files uses: jitterbit/get-changed-files@v1 - - name: Find add-on directories + - name: Find app directories id: addons uses: home-assistant/actions/helpers/find-addons@master - - name: Get changed add-ons + - name: Get changed apps id: changed_addons run: | declare -a changed_addons @@ -50,17 +50,17 @@ jobs: changed=$(echo ${changed_addons[@]} | rev | cut -c 2- | rev) if [[ -n ${changed} ]]; then - echo "Changed add-ons: $changed"; + echo "Changed apps: $changed"; echo "changed=true" >> $GITHUB_OUTPUT; echo "addons=[$changed]" >> $GITHUB_OUTPUT; else - echo "No add-on had any monitored files changed (${{ env.MONITORED_FILES }})"; + echo "No app had any monitored files changed (${{ env.MONITORED_FILES }})"; fi build: needs: init runs-on: ubuntu-latest if: needs.init.outputs.changed == 'true' - name: Build ${{ matrix.arch }} ${{ matrix.addon }} add-on + name: Build ${{ matrix.arch }} ${{ matrix.addon }} app strategy: matrix: addon: ${{ fromJson(needs.init.outputs.changed_addons) }} @@ -79,7 +79,7 @@ jobs: with: path: "./${{ matrix.addon }}" - - name: Check if add-on should be built + - name: Check if app should be built id: check run: | if [[ "${{ steps.info.outputs.image }}" == "null" ]]; then @@ -104,7 +104,7 @@ jobs: username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - - name: Build ${{ matrix.addon }} add-on + - name: Build ${{ matrix.addon }} app if: steps.check.outputs.build_arch == 'true' uses: home-assistant/builder@2026.02.1 with: diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 82644c97..b82ac6e6 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -12,7 +12,7 @@ on: jobs: find: - name: Find add-ons + name: Find apps runs-on: ubuntu-latest outputs: addons: ${{ steps.addons.outputs.addons_list }} @@ -20,12 +20,12 @@ jobs: - name: โคต๏ธ Check out code from GitHub uses: actions/checkout@v6.0.2 - - name: ๐Ÿ” Find add-on directories + - name: ๐Ÿ” Find app directories id: addons uses: home-assistant/actions/helpers/find-addons@master lint: - name: Lint add-on ${{ matrix.path }} + name: Lint app ${{ matrix.path }} runs-on: ubuntu-latest needs: find strategy: @@ -35,7 +35,7 @@ jobs: - name: โคต๏ธ Check out code from GitHub uses: actions/checkout@v6.0.2 - - name: ๐Ÿš€ Run Home Assistant Add-on Lint + - name: ๐Ÿš€ Run Home Assistant App Lint uses: frenck/action-addon-linter@v2.21 with: path: "./${{ matrix.path }}" diff --git a/README.md b/README.md index 18354b21..7e0dadec 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,32 @@ -# Example Home Assistant add-on repository +# Example Home Assistant app repository -This repository can be used as a "blueprint" for add-on development to help you get started. +This repository can be used as a "blueprint" for app development to help you get started. -Add-on documentation: +Apps documentation: -[![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) +[![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) -## Add-ons +## Apps -This repository contains the following add-ons +This repository contains the following apps -### [Example add-on](./example) +### [Example app](./example) ![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] -_Example add-on to use as a blueprint for new add-ons._ +_Example app to use as a blueprint for new apps._ + +## 1.3.0 + +- Updated to Alpine 3.23 base image. +- Renamed from "add-on" to "app". ## 1.2.0 diff --git a/example/DOCS.md b/example/DOCS.md index b8432c3d..1981ad73 100644 --- a/example/DOCS.md +++ b/example/DOCS.md @@ -1,10 +1,10 @@ -# Home Assistant Add-on: Example add-on +# Home Assistant App: Example app ## How to use -This add-on really does nothing. It is just an example. +This app really does nothing. It is just an example. When started it will print the configured message or "Hello world" in the log. -It will also print "All done!" in `/share/example_addon_output.txt` to show -simple example of the usage of `map` in addon config. +It will also print "All done!" in `/share/example_app_output.txt` to show +simple example of the usage of `map` in app config. diff --git a/example/Dockerfile b/example/Dockerfile index 9d1a983c..caea653f 100644 --- a/example/Dockerfile +++ b/example/Dockerfile @@ -1,4 +1,4 @@ -# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile +# https://developers.home-assistant.io/docs/apps/configuration#app-dockerfile ARG BUILD_FROM FROM $BUILD_FROM diff --git a/example/README.md b/example/README.md index 110a7221..b21009ea 100644 --- a/example/README.md +++ b/example/README.md @@ -1,6 +1,6 @@ -# Home Assistant Add-on: Example add-on +# Home Assistant App: Example app -_Example add-on to use as a blueprint for new add-ons._ +_Example app to use as a blueprint for new apps._ ![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] diff --git a/example/apparmor.txt b/example/apparmor.txt index e788a6c0..8f09608f 100644 --- a/example/apparmor.txt +++ b/example/apparmor.txt @@ -24,7 +24,7 @@ profile example flags=(attach_disconnected,mediate_deleted) { /usr/lib/bashio/** ix, /tmp/** rwk, - # Access to options.json and other files within your addon + # Access to options.json and other files within your app /data/** rw, # Start new profile for service @@ -36,7 +36,7 @@ profile example flags=(attach_disconnected,mediate_deleted) { # Receive signals from S6-Overlay signal (receive) peer=*_example, - # Access to options.json and other files within your addon + # Access to options.json and other files within your app /data/** rw, # Access to mapped volumes specified in config.json @@ -45,7 +45,7 @@ profile example flags=(attach_disconnected,mediate_deleted) { # Access required for service functionality # Note: List was built by doing the following: # 1. Add what is obviously needed based on what is in the script - # 2. Add `complain` as a flag to this profile temporarily and run the addon + # 2. Add `complain` as a flag to this profile temporarily and run the app # 3. Review the audit log with `journalctl _TRANSPORT="audit" -g 'apparmor="ALLOWED"'` and add other access as needed # Remember to remove the `complain` flag when you are done /usr/bin/my_program r, @@ -54,4 +54,4 @@ profile example flags=(attach_disconnected,mediate_deleted) { /etc/passwd r, /dev/tty rw, } -} \ No newline at end of file +} diff --git a/example/build.yaml b/example/build.yaml index 8964c2ee..b80f868d 100644 --- a/example/build.yaml +++ b/example/build.yaml @@ -1,11 +1,11 @@ -# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-dockerfile +# https://developers.home-assistant.io/docs/apps/configuration#app-dockerfile build_from: - aarch64: "ghcr.io/home-assistant/aarch64-base:3.15" - amd64: "ghcr.io/home-assistant/amd64-base:3.15" + aarch64: "ghcr.io/home-assistant/aarch64-base:3.23" + amd64: "ghcr.io/home-assistant/amd64-base:3.23" labels: - org.opencontainers.image.title: "Home Assistant Add-on: Example add-on" - org.opencontainers.image.description: "Example add-on to use as a blueprint for new add-ons." - org.opencontainers.image.source: "https://github.com/home-assistant/addons-example" + org.opencontainers.image.title: "Home Assistant App: Example app" + org.opencontainers.image.description: "Example app to use as a blueprint for new apps." + org.opencontainers.image.source: "https://github.com/home-assistant/apps-example" org.opencontainers.image.licenses: "Apache License 2.0" args: TEMPIO_VERSION: "2021.09.0" diff --git a/example/config.yaml b/example/config.yaml index 7630855e..a97e4f28 100644 --- a/example/config.yaml +++ b/example/config.yaml @@ -1,9 +1,9 @@ -# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-config -name: Example add-on -version: "1.2.0" +# https://developers.home-assistant.io/docs/apps/configuration#app-configuration +name: Example app +version: "1.3.0" slug: example -description: Example add-on -url: "https://github.com/home-assistant/addons-example/tree/main/example" +description: Example app +url: "https://github.com/home-assistant/apps-example/tree/main/example" arch: - aarch64 - amd64 @@ -14,4 +14,4 @@ options: message: "Hello world..." schema: message: "str?" -image: "ghcr.io/home-assistant/{arch}-addon-example" +image: "ghcr.io/home-assistant/{arch}-app-example" diff --git a/example/rootfs/etc/services.d/example/finish b/example/rootfs/etc/services.d/example/finish index 230d1792..5bfbdf56 100755 --- a/example/rootfs/etc/services.d/example/finish +++ b/example/rootfs/etc/services.d/example/finish @@ -7,7 +7,7 @@ declare APP_EXIT_CODE=${1} if [[ "${APP_EXIT_CODE}" -ne 0 ]] && [[ "${APP_EXIT_CODE}" -ne 256 ]]; then - bashio::log.warning "Halt add-on with exit code ${APP_EXIT_CODE}" + bashio::log.warning "Halt app with exit code ${APP_EXIT_CODE}" echo "${APP_EXIT_CODE}" > /run/s6-linux-init-container-results/exitcode exec /run/s6/basedir/bin/halt fi diff --git a/example/rootfs/usr/bin/my_program b/example/rootfs/usr/bin/my_program index a287b137..1cde40e4 100755 --- a/example/rootfs/usr/bin/my_program +++ b/example/rootfs/usr/bin/my_program @@ -1,3 +1,3 @@ #!/bin/bash -echo "All done!" > /share/example_addon_output.txt +echo "All done!" > /share/example_app_output.txt diff --git a/example/translations/en.yaml b/example/translations/en.yaml index 70de0241..2da77e4b 100644 --- a/example/translations/en.yaml +++ b/example/translations/en.yaml @@ -1,4 +1,4 @@ configuration: message: name: Message - description: The message that will be printed to the log when starting this example add-on. + description: The message that will be printed to the log when starting this example app. diff --git a/repository.yaml b/repository.yaml index e92d4dad..b6a5b837 100644 --- a/repository.yaml +++ b/repository.yaml @@ -1,4 +1,4 @@ -# https://developers.home-assistant.io/docs/add-ons/repository#repository-configuration -name: Example Home Assistant add-on repository -url: 'https://github.com/home-assistant/addons-example' -maintainer: Awesome Maintainer \ No newline at end of file +# https://developers.home-assistant.io/docs/apps/repository#repository-configuration +name: Example Home Assistant app repository +url: 'https://github.com/home-assistant/apps-example' +maintainer: Awesome Maintainer