1

# Beremiz public distribution #

     2

     3

This repository holds recipes and patches to build the Beremiz related 

     4

bundles, packages, installers and images available on 

     5

[Beremiz website](http://www.beremiz.org/).

     6

     7

Patches have same license as projects beeing patched. For other files,

     8

unless made explicit in file header, GPLv3 applies.

     9

    10

    11

## Prerequisites ##

    12

    13

A usable Docker is required. Docker is used to ensure a reproducible build

    14

environment. 

    15

    16

Other containerization/virtualization could be used to achieve the same effect. 

    17

    18

Reference build environment is obtained by applying [provision_focal64.sh](provision_focal64.sh) on Ubuntu 20.04 amd64.

    19

    20

## Preparing source ##

    21

    22

The top Makefile expects source code of Beremiz, Matiec and CanFestival to be 

    23

sibling to beremiz_public_dist directory, in the 'source directory'.

    24

For example :

    25

    26

```

    27

~/src

    28

     /beremiz

    29

     /beremiz_public_dist

    30

     /canfestival

    31

     /matiec

    32

```

    33

    34

If any of Beremiz, Matiec or CanFestival repositories are missing, they will be

    35

cloned aside beremiz_public_dist from https://hg.beremiz.org .

    36

    37

Intermediate and final results are all placed in a single 'build directory'

    38

during build process.

    39

    40

## Windows installer Build ##

    41

    42

### Prepare Docker image ###

    43

    44

The script [rebuild_docker.sh](rebuild_docker.sh) is used for that purpose.

    45

    46

Synopsis:

    47

    48

    ./rebuild_docker.sh [build directory]

    49

    50

Example:

    51

    52

```

    53

#!sh

    54

mkdir ~/src ~/build

    55

cd ~/src

    56

hg clone https://hg.beremiz.org/beremiz_public_dist

    57

cd beremiz_public_dist

    58

./rebuild_docker.sh

    59

```

    60

    61

Source and Build Volumes :

    62

    63

 Role             | Docker Volume     | Host path in example | Rationale

    64

------------------|-------------------|----------------------|------------------------------------------------

    65

 source directory | /home/devel/src   | ~/src                | Always relative to CWD : "../"

    66

 build directory  | /home/devel/build | ~/build              | First argument to rebuild_docker.sh or ~/build

    67

    68

'build directory' can be specified as absolute path argument of rebuild_docker.sh.

    69

If not specified it defaults to ~/build

    70

    71

```

    72

#!sh

    73

./rebuild_docker.sh ~/build_next

    74

```

    75

    76

Note: 'build directory' is created if not already existing.

    77

    78

### Build Windows Installer ###

    79

    80

The script [build_in_docker.sh](build_in_docker.sh) is used for that purpose.

    81

    82

```

    83

#!sh

    84

./build_in_docker.sh 

    85

```

    86

    87

Note: 'build directory' must exist before calling build_in_docker.sh, otherwise

    88

Docker will create it as root user. Be sure to create it again if you delete it.

    89

    90

Resulting installer is Beremiz-${timestamp}.exe in 'build directory'. 

    91

    92

### Manhole ###

    93

    94

Once Docker image ready, the scripts [enter_docker.sh](enter_docker.sh) and

    95

[enter_docker_as_root.sh](enter_docker_as_root.sh) let you issue build 

    96

commands, or install additional packages.

    97

    98

[clean_docker_container.sh](clean_docker_container.sh) and [create_docker_container.sh](create_docker_container.sh) and 

    99

[clean_docker_image.sh](clean_docker_image.sh) and [build_docker_image.sh](build_docker_image.sh) are invoked by 

   100

[rebuild_docker.sh](rebuild_docker.sh). 

   101

   102

## Snap Package Build ##

   103

   104

snapcraft.yaml does not rely on HG or GIT repos, but refers to local sources, this is responsibility of caller to prepare sources for snapcraft.

   105

   106

Reasons for this are :

   107

 - no parameters or conditional variables exist to tell snapcraft.yaml where to get the source from

   108

 - building from local source should be always possible

   109

 - revisions.txt must be updated in any case so that it is always possible to know what version wqas used to build resulting package

   110

 - when Snap is built from GitHub actions, Makefile isn't used at all, and GitHub action workflow organize sources and revisions.txt on its own.

   111

   112

In the end, instead of just calling `snapcraft` to get a snap package, it is more complicated:

   113

   114

```

   115

#!sh

   116

mkdir ~/src ~/build

   117

cd ~/src

   118

hg clone https://hg.beremiz.org/beremiz_public_dist

   119

cd ~/build

   120

make -f ~/src/beremiz_public_dist/Makefile DIST=snap

   121

   122

```

   123

Resulting snap package is sources/beremiz_${version}_${platform}.snap.

   124

It can be installed this way:

   125

   126

```

   127

sudo snap install sources/beremiz_1.3-beta2_amd64.snap --dangerous --devmode

   128

```

   129