armbian.github.io/README.md

Purpose of This Repository

This repository acts as a central automation and orchestration hub for the Armbian project. It coordinates CI workflows, maintains metadata, syncs external data, and generates machine-readable output to power armbian.com, docs.armbian.com, and related services.

It also produces data exchange files used for automation, reporting, and content delivery across the Armbian infrastructure.

Build & Packaging Automation

• Build Artifacts Assembly
  
  Assembles packages and stores them in the ORAS cache.

• Linux Kernel Shallow Bundles
  
  Packages minimal (shallow) kernel source trees for fast and efficient CI use, reducing clone depth and speeding up build workflows.

• Build Armbian Docker Image
  
  Builds and publishes Docker images for the Armbian Build Framework to the GitHub Container Registry.

• Generate APT Repository
  
  Publishes packages from the ORAS cache and external sources to APT repositories.

Testing & Validation

• Applications Install Testing
  
  Runs unit tests on armbian-config modules to validate install, upgrade, and configuration logic.

• Wireless Performance Testing
  
  Executes Wi-Fi benchmarks on supported devices to identify performance regressions.
  Docs →

Metadata & Content Generation

• Extract Base-Files Metadata
  
  Embeds build metadata into Armbian’s base-files packages.

• Generate weekly release for entire organisation
  
  Compiles a Markdown digest of merged pull requests across one or more repos or an entire org.

• Update Download JSON Index
  Regenerates image download indexes across all supported devices.

• Mirror Comparison & Redirector Config
  
  Compares mirror contents and updates download redirector configs.
  Redirector →

• Generate Authors and Partners JSON
  
  Generates machine-readable lists of authors, sponsors, and partners.

• Pull Excerpts from Armbian Jira
  
  Extracts metadata and summaries from public Jira issues.

Infrastructure & Community

• Mirror GitHub Artifacts to CDN
  
  Syncs release images to Armbian’s CDN for global distribution.

• Invite Recent Contributors
  
  Automatically invites external contributors to join the Armbian GitHub organization.

• Generate Self Hosted Runners Status page
  
  Generates a table of Self Hosted runners with CPU, memory, storage, runner status, and totals.

Documentation

• Generate Documentation
  
  Builds and deploys docs from Markdown sources using MkDocs Material.
  Published to: docs.armbian.com