Build ZimaOS AppStore Action

This composite GitHub Action wraps scripts/build_appstore.py so other repositories can build ZimaOS-compatible AppStore output in a reusable way.

What it does

• sets up Python
• installs required Python dependencies
• optionally installs required Ubuntu system packages
• normalizes base-url
• runs build_appstore.py
• creates a bootstrap metadata bundle containing all generated json/yml files
• optionally writes a structured build-report.json

Runner support

This action currently targets ubuntu-latest or other Debian/Ubuntu-based runners when install-system-deps is left enabled, because it uses apt-get to install librsvg2-bin.

Inputs

Name	Required	Default	Description
source	No	.	Source repository root
output	No	dist	Output directory
base-url	No	""	Base URL prefix for generated asset links
cache-file	No	""	Optional image metadata cache file
digest-cache-file	No	""	Optional image digest cache file
report-json	No	""	Optional structured build report JSON output path
report-title	No	Build V2 Store Report	Optional title used in the structured build report
python-version	No	3.11	Python version used to run the build
install-system-deps	No	true	Whether to install librsvg2-bin via apt-get

Outputs

Name	Description
output-dir	Final output directory passed to build_appstore.py
metadata-bundle	Path to the generated bootstrap metadata tarball
metadata-bundle-sha256	Path to the checksum file for the bootstrap metadata tarball
base-url	Final base URL used for the build
report-json	Structured build report JSON path when enabled
status	Build status captured for the run

Secrets and environment

If you want better registry rate limits and digest resolution coverage, pass these environment variables:

• DOCKERHUB_USERNAME
• DOCKERHUB_TOKEN

Usage

name: Build AppStore

on:
  workflow_dispatch:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Build dist
        uses: IceWhaleTech/build-appstore-action@v1
        with:
          source: .
          output: dist
          base-url: https://cdn.jsdelivr.net/gh/${{ github.repository }}@gh-pages
          cache-file: .cache/build_appstore/image-size-cache.json
          digest-cache-file: .cache/build_appstore/image-digest-cache.json
          report-json: out/build-v2-report.json
          report-title: Build V2 Store Report
        env:
          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
          DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}

If report-json is set, the action writes a machine-readable build report even when the build fails. Workflows can then render HTML reports, write job summaries, or upload the JSON as an artifact.

Bootstrap metadata bundle

Each successful build now also generates:

• dist/metadata.tar.gz
• dist/metadata.sha256

The tarball contains every generated *.json, *.yml, and *.yaml file under dist/, while preserving relative paths. This is intended for first-time store bootstrap, where downloading one compressed metadata bundle is faster than fetching many small files individually.

A recommended client flow is:

1. On first add, download and extract metadata.tar.gz, then verify it with metadata.sha256.
2. After the local cache exists, continue using index.json and each app's content_hash for incremental refreshes.

Publishing as a public action

This repository is already structured as a standalone public action:

1. action.yml is at the repository root.
2. scripts/build_appstore.py is vendored into the repository.
3. requirements.txt lives beside the action metadata.

To publish it for stable reuse:

1. Commit and push the repository contents.
2. Create a release tag such as v1.0.0.
3. Add or move a major tag such as v1.
4. Reference it from workflows as uses: IceWhaleTech/build-appstore-action@v1.

If you later change behavior in a backward-incompatible way, publish that as a new major tag such as v2.