Add Debian package build target to Earthfile

Author: arodage

Earthfile

@@ -139,4 +139,57 @@ test-debug:
 
 test-quick:
     FROM +golang-base
-    RUN go test ./...
+    RUN go test ./...
+
+deb:
+    FROM debian:bookworm-slim
+    ARG VERSION=1.0.0
+    ARG ARCH=amd64
+    
+    WORKDIR /pkg
+    
+    # Create directory structure following FHS (Filesystem Hierarchy Standard)
+    RUN mkdir -p usr/local/bin \
+                 etc/os-image-composer/config \
+                 usr/share/os-image-composer/examples \
+                 usr/share/doc/os-image-composer \
+                 DEBIAN
+    
+    # Copy the built binary from the build target
+    COPY +build/os-image-composer usr/local/bin/os-image-composer
+    
+    # Make the binary executable
+    RUN chmod +x usr/local/bin/os-image-composer
+    
+    # Copy default global configuration (user-editable)
+    COPY os-image-composer.yml etc/os-image-composer/os-image-composer.yml
+    
+    # Copy OS variant configuration files (user-editable)
+    COPY config etc/os-image-composer/config
+    
+    # Copy image templates as examples (read-only, for reference)
+    COPY image-templates usr/share/os-image-composer/examples
+    
+    # Copy documentation
+    COPY README.md usr/share/doc/os-image-composer/
+    COPY LICENSE usr/share/doc/os-image-composer/
+    COPY docs/architecture/os-image-composer-cli-specification.md usr/share/doc/os-image-composer/
+    
+    # Create the DEBIAN control file with proper metadata
+    RUN echo "Package: os-image-composer" > DEBIAN/control && \
+        echo "Version: ${VERSION}" >> DEBIAN/control && \
+        echo "Section: utils" >> DEBIAN/control && \
+        echo "Priority: optional" >> DEBIAN/control && \
+        echo "Architecture: ${ARCH}" >> DEBIAN/control && \
+        echo "Maintainer: Intel Edge Software Team <edge.platform@intel.com>" >> DEBIAN/control && \
+        echo "Depends: bash, coreutils" >> DEBIAN/control && \
+        echo "Description: OS Image Composer (OIC)" >> DEBIAN/control && \
+        echo " OIC enables users to compose custom bootable OS images based on a" >> DEBIAN/control && \
+        echo " user-provided template that specifies package lists, configurations," >> DEBIAN/control && \
+        echo " and output formats for supported distributions." >> DEBIAN/control
+    
+    # Build the debian package
+    RUN dpkg-deb --build . os-image-composer_${VERSION}_${ARCH}.deb
+    
+    # Save the debian package artifact to dist/ directory
+    SAVE ARTIFACT os-image-composer_${VERSION}_${ARCH}.deb AS LOCAL dist/os-image-composer_${VERSION}_${ARCH}.deb

README.md

@@ -36,6 +36,72 @@ earthly +build
 earthly +build --version=1.0.0
 ```
 
+### Install via Debian Package (Ubuntu/Debian)
+
+For Ubuntu and Debian systems, you can build and install OS Image Composer as a Debian package. This method provides a cleaner installation with proper package management.
+
+#### Build the Debian Package
+
+Use the Earthly `+deb` target to create a `.deb` package:
+
+```bash
+# Build with default parameters (version 1.0.0, amd64)
+earthly +deb
+
+# Build with custom version and architecture
+earthly +deb --VERSION=1.2.0 --ARCH=amd64
+
+# Build for ARM64
+earthly +deb --VERSION=1.0.0 --ARCH=arm64
+```
+
+The package will be created in the `dist/` directory as `os-image-composer_<VERSION>_<ARCH>.deb`.
+
+#### Install the Package
+
+```bash
+# Install using apt (recommended - automatically resolves dependencies)
+sudo apt install ./dist/os-image-composer_1.0.0_amd64.deb
+
+# Or using dpkg
+sudo dpkg -i dist/os-image-composer_1.0.0_amd64.deb
+sudo apt-get install -f  # Fix any missing dependencies if needed
+```
+
+#### Verify Installation
+
+```bash
+# Check if package is installed
+dpkg -l | grep os-image-composer
+
+# View installed files
+dpkg -L os-image-composer
+
+# Verify the binary works
+os-image-composer version
+```
+
+#### Package Contents
+
+The Debian package installs the following files:
+
+* **Binary:** `/usr/local/bin/os-image-composer` - Main executable
+* **Configuration:** `/etc/os-image-composer/` - Default configuration and OS variant configs
+* **Examples:** `/usr/share/os-image-composer/examples/` - Sample image templates
+* **Documentation:** `/usr/share/doc/os-image-composer/` - README, LICENSE, and CLI specification
+
+After installation via the Debian package, you can use `os-image-composer` directly from any directory, and reference the example templates from `/usr/share/os-image-composer/examples/`.
+
+#### Uninstall the Package
+
+```bash
+# Remove package (keeps configuration files)
+sudo dpkg -r os-image-composer
+
+# Remove package and configuration files
+sudo dpkg --purge os-image-composer
+```
+
 ### Install the Prerequisites for Composing an Image
 
 Before you compose an operating system image with the OS Image Composer tool, follow the [instructions to install two prerequisites](./docs/tutorial/prerequisite.md):