flatpak-github-actions Docker镜像文档

镜像概述

flatpak-github-actions是一个用于在GitHub Actions中构建Flatpak应用的Docker镜像。其主要用途是通过GitHub Actions工作流自动化构建Flatpak应用，支持配置构建参数、生成Flatpak bundle，并简化Flatpak应用的CI/CD流程。

核心功能和特性

• 支持指定Flatpak应用清单文件路径，实现应用构建配置
• 可自定义应用ID，确保与Flatpak应用标识一致
• 生成指定名称的Flatpak bundle文件，默认名称为app.flatpak
• 支持配置运行时仓库URL，用于用户下载bundle时获取运行时依赖，默认使用Flathub仓库
• 允许传递meson构建参数，用于应用的个性化配置（如指定开发环境）
• 可指定Flatpak模块名称，区分应用模块与依赖模块

使用场景

适用于开发者在GitHub仓库中管理Flatpak应用时，需要通过GitHub Actions实现自动化构建的场景。例如：在代码推送（push）或拉取请求（pull_request）触发时，自动构建Flatpak应用并生成bundle，用于测试、预览或分发。

使用方法

配置GitHub Actions工作流

在GitHub仓库中创建 .github/workflows 目录，并添加 .yml 格式的工作流文件（如 flatpak-build.yml），配置如下：

on: [push, pull_request]
name: Flatpak
jobs:
  flatpak-builder:
    name: "Flatpak Builder"
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: bilelmoussaoui/flatpak-github-actions@wip
      with:
        bundle: "palette.flatpak"
        manifest-path: "org.gnome.zbrown.Palette.yml"
        app-id: "org.gnome.zbrown.Palette"
        runtime-repo: "[***]"
        flatpak-module: "palette"

工作流说明

1. 触发条件：通过 on: [push, pull_request] 设置在代码推送或拉取请求时触发构建。
2. 运行环境：使用 runs-on: ubuntu-latest 指定在Ubuntu环境运行。
3. 步骤：
   • actions/checkout@master：拉取仓库代码到工作流环境。
   • bilelmoussaoui/flatpak-github-actions@wip：使用本Docker镜像执行Flatpak构建，通过 with 配置构建参数。

输入参数（Inputs）

manifest-path

• 描述：仓库中Flatpak应用清单文件的相对路径。
• 必填：是

app-id

• 描述：Flatpak应用的唯一标识（应用ID）。
• 必填：是

bundle

• 描述：生成的Flatpak bundle文件名称。
• 默认值：app.flatpak
• 可选：是

runtime-repo

• 描述：用户下载Flatpak bundle时用于获取运行时依赖的仓库URL。
• 默认值：[***]（Flathub仓库）
• 可选：是

meson-args

• 描述：传递给meson构建工具的配置参数，用于应用的个性化构建配置（如指定开发环境）。
• 示例：-Dprofile=development
• 可选：是

flatpak-module

• 描述：应用的Flatpak模块名称，用于区分应用模块与依赖模块。
• 必填：是