From f192f35dd1d33fe92fe4c7dc4d5befa37e61d5ca Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sun, 28 Dec 2025 18:42:07 +0000 Subject: [PATCH] Update README with release workflow documentation Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com> --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c4c209b..80b3319 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ The current MVP provides: - ✅ Docker container for testing - ✅ Automated builds and publishing to GHCR - ✅ Multi-architecture Docker images (AMD64 and ARM64) +- ✅ CI/CD pipeline for compiled release packages +- ✅ GitHub releases with pre-built binaries ## Prerequisites @@ -43,6 +45,32 @@ To create bootable images (optional): ## Quick Start +### Using Pre-built Releases (Easiest) + +Download the latest release package from the [GitHub Releases page](https://github.com/johndoe6345789/SparkOS/releases): + +```bash +# Download the latest release (replace VERSION with actual version, e.g., v1.0.0) +wget https://github.com/johndoe6345789/SparkOS/releases/download/VERSION/sparkos-release.zip + +# Extract the package +unzip sparkos-release.zip +cd sparkos/ + +# The init binary is already compiled and ready to use +ls -lh init + +# Copy to your rootfs or use directly +cp init /path/to/your/rootfs/sbin/init +``` + +The release package includes: +- Pre-compiled init binary (statically linked, ready to use) +- Complete source code +- Build scripts and configuration +- Root filesystem structure +- Full documentation + ### Using Docker (Recommended for Testing) The easiest way to test SparkOS is using the pre-built Docker image from GitHub Container Registry: @@ -187,10 +215,17 @@ SparkOS uses GitHub Actions for continuous integration and delivery: **Automated Builds:** - Docker images are automatically built on every push to main/develop branches -- Images are also built for pull requests (testing only, not published) -- Tagged releases automatically create versioned Docker images +- Compiled release packages are automatically built on every push to main/develop branches +- Images and releases are also built for pull requests (testing only, not published) +- Tagged releases automatically create versioned Docker images and GitHub releases with compiled binaries - **Multi-architecture builds**: Images are built for both AMD64 (x86_64) and ARM64 (aarch64) +**Compiled Releases:** +- Pre-compiled init binaries are available as GitHub releases for version tags +- Release packages include: compiled init binary, source code, build scripts, and documentation +- Download releases from the [GitHub Releases page](https://github.com/johndoe6345789/SparkOS/releases) +- Build artifacts are available for all workflow runs (retained for 90 days) + **Container Registry:** - Images are published to GitHub Container Registry (GHCR) - Pull images: `docker pull ghcr.io/johndoe6345789/sparkos:latest`