flatpak/README

   1 This directory contains files related to Flatpak build of Evolution. Apart
   2 of Evolution itself, it builds also evolution-data-server, and uses it,
   3 the same as evolution-ews for Exchange Web Services accounts.
   4
   5 The build uses GNOME Flatpak SDK and runtime.
   6
   7 To build it, one can follow the below commands, which expect flatpak and
   8 flatpak-builder installed. Refer to the Flatpak developer documentation
   9 and command man pages for the meaning of respective arguments.
  10
  11 Note the actual versions of the GNOME SDK and Platform (below is used
  12 version 3.26) can differ each release of Evolution. The exact expected
  13 version can be seen (or changed) in the .json file, the runtime-version
  14 key (line "runtime-version": "3.26",). Use the same version in the below
  15 install commands as is written in the runtime-version key of the .json file.
  16
  17 To prepare Flatpak, add GNOME repository and install the SDK and Platform:
  18
  19    $ flatpak remote-add --from gnome https://sdk.gnome.org/gnome.flatpakrepo
  20    $ flatpak install gnome org.gnome.Platform//3.26
  21    $ flatpak install gnome org.gnome.Sdk//3.26
  22
  23 After this, Evolution can be built. While the below commands build the git master
  24 version of Evolution, it can be changed to the stable version, when all "-master"
  25 occurrences are replaced with "-stable":
  26
  27    $ flatpak-builder --force-clean org.gnome.Evolution-master org.gnome.Evolution-master.json
  28
  29 The above command can be repeated multiple times, for cases when the build fails
  30 and any changes are required.
  31
  32 Once it's built, Flatpak requires the built application to be added as a repository,
  33 which means to create, add and install it:
  34
  35    $ flatpak build-export repo-master org.gnome.Evolution-master
  36    $ flatpak --user remote-add --no-gpg-verify --if-not-exists evolution-repo-master repo-master
  37    $ flatpak --user install evolution-repo-master org.gnome.Evolution
  38
  39 And it's basically it. The last thing is to run the flatpak version of Evolution:
  40
  41    $ flatpak run org.gnome.Evolution
  42
  43 In some cases one might need to debug the build environment, which can be done
  44 with the following command. It opens a bash terminal where can be examined
  45 built data in the /app prefix:
  46
  47    $ flatpak run --devel --command=bash org.gnome.Evolution
  48
  49 A short command to rebuild any changes, refresh the repository and update
  50 installed Evolution from this repository can look like:
  51
  52    $ flatpak-builder --force-clean org.gnome.Evolution-master org.gnome.Evolution-master.json && \
  53      flatpak build-export repo-master org.gnome.Evolution-master && \
  54      flatpak --user update org.gnome.Evolution
  55
  56 Note the above commands install the Evolution as a user repository, not
  57 as a system repository, while the GNOME platform and SDK are installed
  58 into the system repository (which requires root password). Add --user
  59 argument to the first three commands at the top to avoid the root requirement.
  60
  61 Finally, to clean up installed Flatpak data, check what is installed:
  62
  63    $ flatpak list
  64
  65 and remove Evolution from there:
  66
  67    $ flatpak --user uninstall org.gnome.Evolution
  68
  69 Then also check what repositories are installed:
  70
  71    $ flatpak remotes
  72
  73 and remove the custom Evolution repository with:
  74
  75    $ flatpak --user remote-delete evolution-repo-master