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 To prepare Flatpak, add GNOME repository and install the SDK and Platform:
  12
  13    $ flatpak remote-add --from gnome https://sdk.gnome.org/gnome.flatpakrepo
  14    $ flatpak install gnome org.gnome.Platform//3.24
  15    $ flatpak install gnome org.gnome.Sdk//3.24
  16
  17 After this, Evolution can be built. While the below commands build the git master
  18 version of Evolution, it can be changed to the stable version, when all "-master"
  19 occurrences are replaced with "-stable":
  20
  21    $ flatpak-builder --force-clean org.gnome.Evolution-master org.gnome.Evolution-master.json
  22
  23 The above command can be repeated multiple times, for cases when the build fails
  24 and any changes are required.
  25
  26 Once it's built, Flatpak requires the built application to be added as a repository,
  27 which means to create, add and install it:
  28
  29    $ flatpak build-export repo-master org.gnome.Evolution-master
  30    $ flatpak --user remote-add --no-gpg-verify --if-not-exists evolution-repo-master repo-master
  31    $ flatpak --user install evolution-repo-master org.gnome.Evolution
  32
  33 And it's basically it. The last thing is to run the flatpak version of Evolution:
  34
  35    $ flatpak run org.gnome.Evolution
  36
  37 In some cases one might need to debug the build environment, which can be done
  38 with the following command. It opens a bash terminal where can be examined
  39 built data in the /app prefix:
  40
  41    $ flatpak run --devel --command=bash org.gnome.Evolution
  42
  43 A short command to rebuild any changes, refresh the repository and update
  44 installed Evolution from this repository can look like:
  45
  46    $ flatpak-builder --force-clean org.gnome.Evolution-master org.gnome.Evolution-master.json && \
  47      flatpak build-export repo-master org.gnome.Evolution-master && \
  48      flatpak --user update org.gnome.Evolution
  49
  50 Note the above commands install the Evolution as a user repository, not
  51 as a system repository, while the GNOME platform and SDK are installed
  52 into the system repository (which requires root password). Add --user
  53 argument to the first three commands at the top to avoid the root requirement.
  54
  55 Finally, to clean up installed Flatpak data, check what is installed:
  56
  57    $ flatpak list
  58
  59 and remove Evolution from there:
  60
  61    $ flatpak --user uninstall org.gnome.Evolution
  62
  63 Then also check what repositories are installed:
  64
  65    $ flatpak remotes
  66
  67 and remove the custom Evolution repository with:
  68
  69    $ flatpak --user remote-delete evolution-repo-master