1

# Beremiz public distribution #

     2

     3

This repository holds recipes and patches to build the Beremiz 

     4

packages and installers for [Beremiz website](http://beremiz.org/).

     5

     6

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

     7

unless made explicit in file header, GPLv3 applies.

     8

     9

## Use cases ##

    10

    11

Beremiz development uses Mercurial, but git repositories that are kept in sync.

    12

    13

Build from both Mercurial and Git repositories is supported.

    14

    15

### GitHub CI ##

    16

    17

Use code from https://github.com/beremiz repositories.

    18

    19

Workflows described in .github/workflows are meant to run on a GitHub runner. Please refer to GitHub documentation to run workflows on your own fork.

    20

    21

Dockerfile and part of Makefiles are used for windows installer build, but for Snap build, only snapcraft.yaml is used.

    22

    23

### Manual build ###

    24

    25

Use code from your local Mercurial repositories, cloned from https://hg.beremiz.org

    26

    27

Uses Makefiles and Dockerfile to build windows installer and Makefile+snapcraft.yaml for Snap package.

    28

    29

Hereafter is documented how to use Makefile and Docker in case of Manual Build

    30

    31

## Prerequisites ##

    32

    33

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

    34

environment. 

    35

    36

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

    37

    38

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

    39

    40

## Preparing source ##

    41

    42

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

    43

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

    44

For example :

    45

    46

```

    47

~/src

    48

     /beremiz

    49

     /beremiz_public_dist

    50

     /matiec

    51

     /canfestival [optional]

    52

     /Modbus      [optional]

    53

     /open62541   [optional]

    54

```

    55

    56

Repositories can be cloned from https://hg.beremiz.org .

    57

    58

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

    59

during build process.

    60

    61

## Windows installer Build ##

    62

    63

### Prepare Docker image ###

    64

    65

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

    66

    67

Synopsis:

    68

    69

    ./rebuild_docker.sh [build directory]

    70

    71

    72

Source and Build Volumes :

    73

    74

 Role             | Docker Volume     | Host path in example | Rationale

    75

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

    76

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

    77

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

    78

    79

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

    80

If not specified it defaults to ~/build

    81

    82

```

    83

#!sh

    84

./rebuild_docker.sh ~/build_next

    85

```

    86

    87

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

    88

    89

### Build Windows Installer ###

    90

    91

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

    92

    93

```

    94

#!sh

    95

./build_in_docker.sh 

    96

```

    97

    98

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

    99

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

   100

   101

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

   102

   103

### Manhole ###

   104

   105

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

   106

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

   107

commands, or install additional packages.

   108

   109

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

   110

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

   111

[rebuild_docker.sh](rebuild_docker.sh). 

   112

   113

## Snap Package Build ##

   114

   115

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.

   116

   117

Reasons for this are :

   118

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

   119

 - building from local source should be always possible

   120

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

   121

 - 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.

   122

   123

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

   124

   125

```

   126

# assuming source repositories are cloned in ~/src 

   127

# and build happens in ~/build

   128

   129

cd ~/build

   130

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

   131

   132

```

   133

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

   134

It can be installed this way:

   135

   136

```

   137

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

   138

```

   139