1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<p align="center">
<img src="https://raw.githubusercontent.com/flatpak/flatpak/main/flatpak.png" alt="Flatpak icon"/>
</p>
`flatpak-builder` is a tool for building [flatpaks](https://flatpak.org) from sources.
It reads a JSON or YAML based manifest to automatically download, build, and install projects which eventually get exported into a flatpak.
For information on the manifest format see `man flatpak-manifest`. A JSON Schema for this format is [available here](https://github.com/flatpak/flatpak-builder/blob/main/data/flatpak-manifest.schema.json).
To use the JSON schema, in [an editor with support](https://code.visualstudio.com/docs/languages/json) for schemas, you can include this line in your manifest:
```json
"$schema": "https://raw.githubusercontent.com/flatpak/flatpak-builder/main/data/flatpak-manifest.schema.json"
```
For information on the command-line tool see `man flatpak-builder` or the [online documentation](https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html).
# Installation
Flatpak-builder uses the [Meson build system](https://mesonbuild.com/). To build just do:
```sh
meson setup _build
meson install -C _build
```
Configure arguments are documented in `meson_options.txt`.
# Versioning Policy
Flatpak Builder, like Flatpak, follows the GLib-style versioning policy,
where the version is formatted as `MAJOR.MINOR.PATCH`. The `MAJOR`
version is currently set to `1`.
- Odd `MINOR` versions indicate an unstable release.
- Even `MINOR` versions indicate a stable release.
Stable releases are limited to bug fixes and minor, non-breaking
improvements. Each stable release line is maintained on a dedicated
`flatpak-builder-1.MINOR.x` branch.
At any given time, only one unstable release line and only one stable
release line are supported.
## Supported versions
The currently supported release lines are:
| Release line | Supported | Status |
| -------------| ------------------ | --------------------|
| 1.5.x | Yes | Development branch |
| 1.4.x | Yes | Stable branch |
## Runtime dependencies
The `flatpak-builder` tool requires `flatpak` being available on the host to
function. Depending on the manifest used it also requires some commands be available on
the host.
Very commonly used:
* sh
* patch
* tar
* cp
* git
* 7z
* bsdunzip (libarchive)
* git-lfs
Rarely used:
* rpm2cpio & cpio
* svn
* bzr
# Maintainance docs
Please see the [maintainance docs](https://github.com/flatpak/flatpak-builder/blob/main/MAINT.md).
|
