Add README documentation for composefs CI pipeline
All checks were successful
Build composefs with Debian packaging / build (push) Successful in 34s

This commit is contained in:
robojerk 2025-09-05 13:12:46 -07:00
parent 112081ce1d
commit 1e5a739dec

41
README.md Normal file
View file

@ -0,0 +1,41 @@
# Composefs CI/CD Pipeline
This repository contains the CI/CD pipeline for building and packaging `composefs` - a content-addressable filesystem for containers.
## What's Included
- **Dockerfile**: Builds composefs with meson/ninja and FUSE support
- **CI Workflow**: Complete CI/CD pipeline that:
- Builds composefs from source
- Creates Debian packages
- Uploads to Forgejo Debian Registry
- Uses apt-cacher-ng for faster builds
## Features
- ✅ **Source Build**: Builds composefs from GitHub source
- ✅ **Debian Packaging**: Creates proper .deb packages
- ✅ **FUSE Support**: Includes FUSE filesystem support
- ✅ **Registry Upload**: Automatically uploads to Forgejo
- ✅ **Caching**: Uses apt-cacher-ng for faster builds
- ✅ **Docker Integration**: Uses Docker for isolated builds
## Usage
The CI workflow will automatically:
1. Clone the composefs source code
2. Build it with meson/ninja
3. Create a Debian package
4. Upload to the Forgejo Debian Registry
## Dependencies
- `libc6 (>= 2.39)`
- `libfuse3-3 (>= 3.10.0)`
## Installation
Once the CI runs successfully, install with:
```bash
apt install composefs
```