Compose

Job Level Variables Section

The Monteur's Variables Processing features. All variables defined in this job-wide configuration file only visible to ALL Compose 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 -}}'

• [Variables] - plain variables list complying to Montuer Plain Variables Definition.

• [FMTVariables] - formattable variables list complying to Montuer Formattable Variables Definition.

Recipe's Metadata Section

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

1
2
3
4
5
6
7
8

[Metadata]
Name = 'Hugo'
Description = """
Using Hugo static site generator to compose Montuer's web documentations
artifacts.
"""

...

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

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
11
12
13

...

[Variables]
MainLang = 'en'
PublishBranch = 'gh-pages'
PublishCommitID='Will be overwritten by publish command sequences'

[FMTVariables]
SourceDir = '{{- .RootDir -}}/.configs/hugo'
DestinationDir = '{{- .WorkingDir -}}/public'
PublishDir = '{{- .WorkingDir -}}/{{- .PublishBranch -}}'

...

• [Variables] - plain variables list complying to Montuer Plain Variables Definition.

• [FMTVariables] - formattable variables list complying to Montuer Formattable Variables Definition.

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 = 'Hugo'
Condition = 'all-all'
Type = 'command'
Command = 'hugo'

[[Dependencies]]
Name = 'Git'
Condition = 'all-all'
Type = 'command'
Command = 'git'

...

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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

...

[[CMD]]
Name = "Delete Destination Directory for Clean Build"
Type = 'delete-recursive-quiet'
Condition = [ 'all-all' ]
Source = '{{- .DestinationDir -}}'

[[CMD]]
Name = "Hugo Build with Minimifaction"
Type = 'command'
Condition = [ 'all-all' ]
Location = '{{- .SourceDir -}}'
Source = 'hugo --minify --destination "{{- .DestinationDir -}}"'

[[CMD]]
Name = "Hugo Workaround with 404"
Type = 'copy-quiet'
Condition = [ 'all-all' ]
Location = '{{- .SourceDir -}}'
Source = '{{- .DestinationDir -}}/{{- .MainLang -}}/404.html'
Target = '{{- .DestinationDir -}}/404.html'

[[CMD]]
Name = "Script No Jekyll file for Github compatibility"
Type = "script"
Condition = [ 'all-all' ]
Location = '{{- .SourceDir -}}'
Source = 'No Jekyll'
Target = '{{- .DestinationDir -}}/.nojekyll'

[[CMD]]
Name = "Copy GitLab CI if available"
Type = 'copy-quiet'
Condition = [ 'all-all' ]
Source = '{{- .RootDir -}}/.gitlab-ci.yml'
Target = '{{- .DestinationDir -}}/.gitlab-ci.yml'

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