Package

Monteur provides Package CI Job to pack your project or app into various distribution packages in a scalable and maintainable manner.

The objective of the job is simple: to package the project or app into various distribution packages per their respective requirements in a scalable yet maintainable manner.

All users has to do is to issue this command: 

1

montuer package

Job Level Configurations

Montuer does facilitate a job-wide configurations file for configuring Package CI Job over all settings and supplying job-wide variables.

The configurations, by default, are stored in the data file located in: 

1

.configs/monteur/package/config.toml

The file MUST be strictly named config alongside with the following supported data format's file extension. Currently, Monteur offers the following supported formats, arranged in priority by sequences: The file structure of the recipe configuration file is detailed from top to bottom in the following sub-sections, in sequences.

Job Level Variables Section

The Monteur's Variables Processing features. All variables defined in this job-wide configuration file only visible to ALL Package CI Job recipes. It is highly recommended to place all project-based variables data into this list for recipes consistency purposes.

An example of the job-level variables section consists of the following fields: 

1
2
3
4
5
6

[Variables]
Version = '1.17.3'
BaseURL = 'https://golang.org/dl/'

[FMTVariables]
Command = 'go{{- .Version -}}'

Recipe Configuration File

All Package CI Job's recipe configuration files are stored in: 

1

.configs/monteur/package/jobs/

These files can have any filename BUT MUST STRICTLY HAVE any of the the following supported file extensions based on its data format of your choice: The file structure of the recipe configuration file is detailed from top to bottom in the following sub-sections, in sequences, and in the recommended TOML format.

Recipe's Metadata Section

The recipe's metadata section consists of the following fields: 

1
2
3
4
5
6

[Metadata]
Name = 'Tar Gunzip'
Description = """
Package application into a single .tar.gz package.
"""
Type = 'targz'

  • Name - used for recipe identification, reporting, and referencing usage. Monteur recommends keeping it short, concise and without any weird symbols (e.g. space will be replaced by short dash (-)).

  • Description - mainly for logging and reporting purposes. Describe the details of the recipe.

  • Type - select the built-in packager type. Refers to Packaging Meta Specification for available packager types.

Recipe's Variables Section

The Monteur's Variables Processing Specification features. All variables defined in this recipe's configuration file are visible ONLY to this recipe. It is highly recommended to abstract as much variables away from your command algorithm as possible so that your user only has to customize these tables and not messing with your algorithm.

The variables section consists of the following fields: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

...

[Variables]
GPGID = '[email protected]'
GPGExistence = ''  # to be filled by [CMD]

[FMTVariables]
LicensePath = '{{- .RootDir -}}/docs/en/licenses/monteur-software-license.pdf'

...

Recipe's Dependencies Checking Section

The Monteur's Dependencies Checking features. All 3rd-party dependencies are listed and checked here against the running operating system for ensuring consistent performances and executions of this recipe.

The data structure is compliant to Dependencies Checking Specification. Here is a sample for this recipe: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

...

[[Dependencies]]
Name = 'DEB Builder'
Condition = 'all-all'
Type = 'command'
Command = 'debuild'

[[Dependencies]]
Name = 'GPG Tool'
Condition = 'all-all'
Type = 'command'
Command = 'gpg'

...

Recipe's Package Meta Section

The Monteur's Package Meta Processing features. All the recipe's commands shall be executed horizontally across these packages repeatedly.

The data structure is complying to the Package Meta Processing Specification. An example would be: 

 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

[Packages.linux-amd64]
OS = [ 'linux' ]
Arch = [ 'amd64' ]
Name = '{{- .App.ID -}}-{{- .App.Version -}}-{{- .PkgOS -}}-{{- .PkgArch -}}'
Changelog = '{{- .DataDir -}}/debian/changelog-{{- .PkgArch -}}'
Distribution = [
        'stable',
]
BuildSource = false

[Packages.linux-amd64.Files]
'{{- .PackageDir -}}/monteur' = '{{- .BuildDir -}}/{{- .PkgOS -}}-{{- .PkgArch -}}'


[Packages.linux-arm64]
OS = [ 'linux' ]
Arch = [ 'arm64' ]
Name = '{{- .App.ID -}}-{{- .App.Version -}}-{{- .PkgOS -}}-{{- .PkgArch -}}'
Changelog = '{{- .DataDir -}}/debian/changelog-{{- .PkgArch -}}'
Distribution = [
        'stable',
]
BuildSource = false

[Packages.linux-arm64.Files]
'{{- .PackageDir -}}/monteur' = '{{- .BuildDir -}}/{{- .PkgOS -}}-{{- .PkgArch -}}'


[Packages.linux-armhf]
OS = [ 'linux' ]
Arch = [ 'armhf' ]
Name = '{{- .App.ID -}}-{{- .App.Version -}}-{{- .PkgOS -}}-{{- .PkgArch -}}'
Changelog = '{{- .DataDir -}}/debian/changelog-{{- .PkgArch -}}'
Distribution = [
        'stable',
]
BuildSource = false

[Packages.linux-armhf.Files]
'{{- .PackageDir -}}/monteur' = '{{- .BuildDir -}}/{{- .PkgOS -}}-arm'

Recipe's Commands Section

The list of executing commands complying to compliant to Commands Execution Unit (CEU) Specification. The commands are executed as instructed in the key recipe sections, usually either execute as per se after all meta processing OR being used to execute horizontally.

The data structure is entirely based on the Commands Execution Unit (CEU) Specification. An example of this recipe's commands section would be: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

...

[[CMD]]
Name = "Get GPG Secret Key for Verifications"
Type = 'command'
Condition = [ 'all-all' ]
Source = 'gpg --list-secret-keys "{{- .GPGID }}"'
Save = 'GPGExistence'

[[CMD]]
Name = "Verify GPG Secret Key Must Exists For Signing"
Type = 'is-not-empty'
Condition = [ 'all-all' ]
Source = '{{- .GPGExistence -}}'

[[CMD]]
Name = "Compile Deb Package with Debuild"
Type = 'command'
Condition = [ 'all-all' ]
Location = '{{- .PackageDir -}}'
Source = 'debuild -b -k{{- .GPGID }} -a{{- index .PkgArch 0 }}'

Currently, this is the last section of the recipe configuration file.

Known Recipes

Instead of working on all the recipes from scratch, Monteur does maintain a number of existing and continuously improved recipes to kick-start your compatible deployment. Here are the available recipes: