https://github.com/mgoltzsche/hifiberry-detector
Containerized detect-hifiberry script from hifiberry-os
https://github.com/mgoltzsche/hifiberry-detector
Last synced: 6 months ago
JSON representation
Containerized detect-hifiberry script from hifiberry-os
- Host: GitHub
- URL: https://github.com/mgoltzsche/hifiberry-detector
- Owner: mgoltzsche
- License: apache-2.0
- Created: 2023-01-23T01:25:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T01:59:59.000Z (about 2 years ago)
- Last Synced: 2025-07-25T22:54:24.735Z (about 1 year ago)
- Language: Makefile
- Homepage:
- Size: 68.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hifiberry-detector
Containerized `detect-hifiberry` script from [HiFiBerryOS](https://github.com/hifiberry/hifiberry-os), configuring the driver overlay for your [HiFiBerry](https://www.hifiberry.com/) HAT automatically.
## Usage
Either install it as app using the [kubemate](https://github.com/mgoltzsche/kubemate) GUI or run:
```sh
docker run --rm --privileged --pid host -v /:/host -v /dev:/dev -v /lib/modules:/lib/modules ghcr.io/mgoltzsche/hifiberry-detector:
```
(Within that command, you have to replace `` with the latest version without the leading `v`.)
## Development
To list the supported targets, run `make help`.
### Prerequisites
* git
* make
* [docker 20+](https://docs.docker.com/engine/install/)
* [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
### Build the application
To build the application container image using [skaffold](https://skaffold.dev), run:
```sh
make image
```
### Deploy the application
To deploy the application using [skaffold](https://skaffold.dev), run:
```sh
make deploy
```
To deploy the application in debug mode (debug ports forwarded), stream its logs and redeploy on source code changes automatically, run:
```sh
make debug
```
To undeploy the application, run:
```sh
make undeploy
```
### Apply blueprint updates
To apply blueprint updates to the application codebase, update the [kpt](https://kpt.dev/) package:
1. Before updating the package, make sure you don't have uncommitted changes in order to be able to distinguish package update changes from others.
2. Call `make blueprint-update` or rather [`kpt pkg update`](https://kpt.dev/reference/cli/pkg/update/) and [`kpt fn render`](https://kpt.dev/reference/cli/fn/render/) (applies the configuration within [`setters.yaml`](./setters.yaml) to the manifests and `skaffold.yaml`).
3. Before committing the changes, review them carefully and make manual changes if necessary.
TL;DR: [Variant Constructor Pattern](https://kpt.dev/guides/variant-constructor-pattern)
## Release
The release process is driven by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/), letting the CI pipeline generate a version and publish a release depending on the [commit messages](https://semantic-release.gitbook.io/semantic-release/#commit-message-format) on the `main` branch.