forked from RDTK/generator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
changes.sexp
843 lines (719 loc) · 32 KB
/
changes.sexp
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
((:release "0.34" nil
(:enhancement
"The parameters aspect now supports the parameter kind
\"password\". However, a default value cannot be specified for
parameters of this kind.")
(:enhancement
"When a variant of the" (:verb "--on-error ") "commandline option is
supplied, errors during the analysis of a git repository (for example
due to the repository being private) should no longer prevent the
generation of a basic SCM configuration for the corresponding job.")
(:bugfix
"The" (:verb "install-jenkins") "command is now more careful about
downloading plugin versions that are compatible with the downloaded
Jenkins core. The command also tries to prevent newer Jenkins versions
from entering the setup wizard when started for the first time.")
(:bugfix
"Configurations involving the" (:verb "warnings-ng") "plugin should no
longer break with every update of the plugin (Thanks to Robert Haschke).")
(:bugfix
"The variables" (:verb "scm.username") "and" (:verb "scm.password")
"are handled correctly."))
(:release "0.33" "2020-12-07"
(:incompatible-change
"The following Jenkins plugins have been deprecated and seem to no
longer be available for download:"
(:ul
"Warnings"
"Task Scanner"
"Checkstyle"
"PMD")
"For this reason, the generator no longer attempts to install the
plugins when installing a new Jenkins instance. The \"Warnings
NG\" plugin has replaced the above plugins. The generator
therefore now generates configuration data for the \"Warnings NG\"
plugin by default."
"For Jenkins instances that have the deprecated plugins installed,
the previous generator behavior can be selected by setting the
following variables:"
(:verb
"-D aspect.checkstyle.implementation=legacy
-D aspect.pmd.implementation=legacy
-D aspect.tasks.implementation=legacy
-D aspect.warnings.implementation=legacy"))
(:enhancement
"The variable" (:verb "message") "can be used to specify a message
that should be displayed after processing a project or
distribution. The" (:verb "generate") "command displays all such
messages as the final output before terminating the generator
process."
"Example message for a distribution:"
(:verb "job-list: |
* ${jobs.list}
message: >-
Will install your stuff into ${toolkit.dir}.
Generated the following jobs:
@{job-list}"))
(:enhancement
"The" (:verb "!b!include FILENAME") "and"
(:verb "!b!literal-include FILENAME") "constructs can now refer to
the to-be-included file in three ways"
(:ul
((:verb "FILENAME-NOT-STARTING-WITH-/") "is interpreted as a
filename relative to the directory of the recipe file in which
the include construct occurs.")
((:verb "/REST-OF-FILENAME-NOT-STARTING-WITH-/") "is interpreted
as an absolute filename.")
((:verb "//REST-OF-FILENAME") "is interpreted as a filename
relative to the root directory of the repository containing the
recipe file in which the include construct occurs, that
is" (:verb "REPOSITORY-ROOT/REST-OF-FILENAME") "."))
"So assuming a repository" (:verb "/home/recipes") "containing a
recipe" (:verb "/home/recipes/projects/my-project.project") ",
include filename would be resolved as follows"
(:verb
"!b!include patches/patch.diff → /home/recipes/projects/patches/patch.diff
!b!include /usr/share/patches/patch.diff → /usr/share/patches/patch.diff
!b!include //patches/patch.diff → /home/recipes/patches/patch.diff")))
(:release "0.32" "2019-10-29"
(:bugfix
"Apparently, Jenkins at some point changed the way it installs and
loads plugins such that it now expects installed plugin file to
use the \"jpi\" extension. The" (:verb "install-jenkins") "command
now uses this extension.")
(:bugfix
"The JSON report kind works again.")
(:enhancement
"Jenkins recently started using a stricter cross-site request
forgery (CSRF) protection scheme combining session cookies and a
CSRF protection token. This stricter scheme is now supported.")
(:enhancement
"The new variable" (:verb "dependencies.required-upstream-result")
"controls the required status of upstream jobs in order to trigger
builds of downstream jobs. Possible values are:"
(:ul
((:verb "success") "- All upstream jobs must have successful
builds.")
((:verb "unstable") "- All upstream jobs must have
unstable (e.g. with test failures) or successful builds.")
((:verb "any") "- The build of the downstream job can start
irregardless of the status of the upstream jobs."))
"The new variable" (:verb "dependencies.required-result") "can be
used to specify the status of jobs required to trigger downstream
jobs. This can be used to relax the threshold established
via" (:verb "dependencies.required-upstream-result") "in cases in
which a known-unreliable upstream should still trigger downstream
jobs. Note that marking the upstream job avoids the need to adapt
the threshold in all downstream jobs.")
(:enhancement
"Dependency specifications (for example in the"
(:verb "extra-requires") "," (:verb "extra-provides") ","
(:verb "platform-requires") "and" (:verb "platform-provides")
"variables) can now use the following shorthand syntax:"
(:verb "NATURE: TARGET") "instead of the usual"
(:verb "nature: NATURE
target: TARGET")))
(:release "0.31" "2019-08-20"
(:enhancement
"The analysis cache is now used by default. The default cache
directory is obtained by appending" (:verb "build-generator/") "to
the XDG user cache directory.")
(:enhancement
"Template directories in recipe repositories can now contain
a" (:verb "parents") "file referencing other template directories
in the same repository."
"Syntactically the" (:verb "parents") "file is a YAML document the
root node of which is a sequence of scalar nodes each of which is a
relative directory pathname:"
(:verb "# Fall back to templates in _common directory
- ../_common"))
(:enhancement
"Recipe repositories can now contain a" (:verb "parents") "file
referencing other recipe repositories. The basic idea is: when a
required recipe file cannot be found in the local repository,
referenced repositories are probed and the recipe is loaded from a
referenced repository if it can be found in one."
"Syntactically the" (:verb "parents") "file is a YAML document the
root node of which is a sequence of a single scalar node which is
either "
(:ul
("a directory pathname:"
(:verb "# Load recipes from sibling repository:
- ../recipes-core/"))
("or a git URL:"
(:verb "# Load recipes from remote repository:
- https://github.com/rdtk/recipes-core")
"A specific branch of a remote repository can be specified using
the fragment part of the URL:"
(:verb "# Load recipes from remote repository:
- https://github.com/rdtk/recipes-core#master
^^^^^^ branch")))
"Referenced remote repositories are cloned into the configured
cache directory when first accessed and updated on subsequent
accesses.")
(:enhancement
"Analysis of the CMake" (:verb "include()") "commands succeeds in
more cases.")
(:enhancement
"Analysis of ASDF systems can now extract executable
names (" (:verb ":build-pathname") ") and entry
points (" (:verb ":entry-point") ") from system definitions.")
(:enhancement
"The" (:verb "install-jenkins") "command no longer silently accepts
invalid Jenkins usernames."))
(:release "0.30" "2019-06-25"
(:incompatible-change
"The" (:verb "non-interactive") "commandline option is no longer
accepted. This change represents no reduction in functionality
since the option did not have any effect.")
(:enhancement
"Computing variable values is substantially faster than before. As
a result, many user-level commands complete more quickly:
generating Jenkins jobs, computing system requirements and
generating reports.")
(:enhancement
"It is no longer necessary to create symbolic links for template
recipe files that are shared between multiple modes. When a
required template file" (:verb "MODE/NAME.template") "does not
exist," (:verb "_common/NAME.template") "is tried instead.")
(:enhancement
"Recipe files can now be placed into sub-directories. The
respective directory name or names are part of the object name:"
(:verb "Filename Object name
projects/ordinary.project → \"ordinary\"
projects/sub-directory/special.project → \"sub-directory/special\"
distributions/sub1/sub2/two.distribution → \"sub1/sub2/two\"")
"The respective include syntax for projects and distributions uses
this object name - not a (relative) path."))
(:release "0.29" "2019-05-24"
(:enhancement
"Analysis of projects with" (:verb "cmake") "nature now
recognizes" (:verb "find_library") "and" (:verb "find_program") "calls
and turns them into the following feature requirements:"
(:verb
"
find_library(OUTPUT_VAR NAME …) → nature: library
target: NAME
find_program(OUTPUT_VAR NAME …) → nature: program
target: NAME"))
(:enhancement
"The" (:verb "generate") "command uses a better default pattern for
deleting previously generated jobs if
the" (:verb "delete-other") "commandline option is supplied,
but" (:verb "delete-other-pattern") "is not supplied. The new
default value corresponds to the regular
expression" (:verb "(DISTRIBUTION-NAME₁|DISTRIBUTION_NAME₂|…)$")
"where" (:verb "DISTRIBUTION-NAMEₖ") "are the names of the
distributions for which jobs are being generated.")
(:enhancement
"The console timestamper plugin for Jenkins is now supported.")
(:enhancement
"The console ANSI color plugin for Jenkins is now supported."))
(:release "0.28" "2019-04-15"
(:incompatible-change
"The legacy syntax for including project versions in distribution
recipes, i.e." (:verb "[ \"NAME\", \"VERSION₁\", \"VERSION₂\", … ]")
", is no longer recognized.")
(:enhancement
"Variable assignments specified on the commandline
using" (:verb "-D NAME=VALUE") "are now taken into account when
resolving project version includes in distribution recipes."
"That is, a project version include in a distribution recipe like
the following"
(:verb
"variables:
foo-tag: '1.1'
versions:
- project@v${foo-tag}")
"is now affected by a" (:verb "-D foo-tag=\"1.2\"") "commandline
option.")
(:bugfix
"Analysis results for archives are now cached in some cases that
should have worked but did not.")
(:enhancement
"The variable" (:verb "platform-provides") "can now be used to
describe system packages in terms of provided features, thus
interfacing with the automatically analyzed or manually declared
required features of projects."
"For example, the following entry could be used to describe the
Protocol Buffers C++ Library:"
(:verb
"platform-provides:
- name: protocol-buffers-cpp-library
variables:
extra-provides:
- nature: cmake
target: ProtocolBuffers
platform-requires:
ubuntu:
packages:
- libprotobuf-dev")
"A project version requiring" (:verb "cmake:ProtocolBuffers")
"would then automatically gain" (:verb "libprotobuf-dev") "as a
platform requirement.")
(:enhancement
"Printing of error and warning messages has been improved:"
(:ul
("Error and warning messages are now printed in color if it makes
sense in the current context (apparently running interactively,
non-dumb terminal)")
("Messages should no longer be printed twice")))
(:bugfix
(:verb "ssh") "sub-processes (started by" (:verb "git") ") should
no longer hang when encountering issues during host key
verification.")
(:enhancement
"When processing information representing a person, names and email
address explicitly specified in the" (:verb "name") ","
(:verb "aliases") "and" (:verb "identities") "sections of the
corresponding" (:verb "person") "recipe take precedence over
information collected during automatic analysis of project
repositories.")
(:enhancement
"The" (:verb "install-jenkins") "command now accepts a"
(:verb "profile") "option which can be used to choose among
different Jenkins configuration profiles. The following profiles
are currently built in:"
(:ul
((:verb "single-user") "(default): the Jenkins installation will
be used by a single user without additional slaves")
((:verb "local-docker") ": the Jenkins installation will use the
Docker daemon on the local machine to dynamically create
slaves"))))
(:release "0.27" "2019-03-11"
(:enhancement
"The new" (:verb "create-jenkins-user") "command creates a user
account in a Jenkins installation to which filesystem-level access
is available.")
(:enhancement
"The new" (:verb "install-jenkins") "command downloads, installs
and configures a Jenkins instance into a given directory. To avoid
Jenkins' initial setup wizard, a user account is also created.")
(:enhancement
"When analyzing Git repositories, the" (:verb "git ls-remote")
"invocation is no longer mandatory in all cases. Instead, results
of these invocations are stored in a timestamped cached and reused
while still recent enough."
"The new configuration
option" (:verb "global.cache-age-limit") "and the corresponding
commandline option" (:verb "cache-age-limit") "control how long
after their creation cached results are still considered recent
enough. The default value is" (:verb "1800") "seconds.")
(:enhancement
"The new" (:verb "config") "command allows inspecting configuration
sources and the current configuration."))
(:release "0.26" "2019-02-19"
(:enhancement
"The HTML report publisher plugin for Jenkins is now supported.")
(:enhancement
"When the first attempt at cloning a mercurial repository fails, a
second attempt without using \"bundles\" is made.")
(:enhancement
"Error reports printed during the analysis and deployment phases
now always include the project and/or project version name.")
(:enhancement
"The \"Jenkins Warnings Plugin - Next Generation\" plugin is now
supported. However, generated job configurations continue to
select the legacy warnings and tasks plugins by default."
"The following commandline options can be used to generate job
configurations which select the new plugin:"
(:verb "-D aspect.checkstyle.implementation=ng
-D aspect.pmd.implementation=ng
-D aspect.tasks.implementation=ng
-D aspect.warnings.implementation=ng"))
(:enhancement
"The behavior in case of errors can now be controlled at a finer
level of granularity. To this end, the" (:verb "on-error")
"commandline option, in addition to the previous values, now
accepts a policy specification adhering to the following grammar:"
(:verb "error-policy ::= rule* default
rule ::= error \"=>\" action \":\"
error ::= \"object-error\" | \"simple-object-error\"
| \"syntax-error\" | \"repository-access-error\"
| \"repository-analysis-error\"
| \"project-analysis-error\" | \"analysis-error\"
| \"dependency-error\" | \"instantiation-error\"
| \"deployment-error\" | \"report-error\"
default ::= action
action ::= \"abort\" | \"fail\" | \"continue\" | \"debug\"")
"Example:"
(:verb "
dependency-error=>continue:analysis-error=>fail:abort
")
"The above continues the run with exit code zero in case"
(:verb "dependency-error") "s are encountered, continues and
returns a non-zero exit code for" (:verb "analysis-error") "s and
immediately aborts with non-zero exit code for all other
errors.")
(:enhancement
"Distribution recipes can now include other distribution recipes in
a new" (:verb "include") "section."
"Distribution includes can be written in two forms, either"
(:verb "include:
- NAME")
"or"
(:verb "- name: NAME
parameters:
PARAMETER₁: VALUE₁
PARAMETER₂: VALUE₂
⋮")
"where" (:verb "NAME") "is the name of a distribution (without file
extension) and PARAMTERₖ: VALUEₖ are variable bindings that should
overwrite bindings in the included distribution. Included
distributions can in turn include other distributions."
"Variables referenced in projects (and jobs and aspects) are now
looked up in the following order (most specific, highest priority
first):"
(:ul
"Specified as a parameter when (directly) including the project
version in a distribution"
("Specified as a variable in an entry in the" (:verb "versions") "
section of the project recipe")
("Specified as a variable in the global" (:verb "variables") "
section of the project recipe")
"Specified as a parameter when including the distribution which in
turn directly includes the project version"
"Specified as a variable in the distribution which directly
includes the project version"
"Specified a as variable in the \"outermost\" (that is, given on
the commandline) distribution")
"If a given project version is included in multiple distributions,
the instance (and in particular the parameters of that instance)
that appears first in terms of a depth-first traversal
of" (:verb "include") "relations is used while all others are
discarded."
"Note that the textual order of the" (:verb "include") "and"
(:verb "versions") "sections in distribution recipes has no bearing
on the ordering described above."))
(:release "0.25" "2018-11-14"
(:incompatible-change
"JSON syntax in recipes is no longer explicitly supported but note
that the current YAML syntax includes JSON as a subset. For
recipes which are syntactically valid JSON, differences in
behavior may arise around line breaks in quoted strings.")
(:enhancement
"Entries in the" (:verb "versions") "section of project recipes now
allow using the key" (:verb "pattern") "instead
of" (:verb "name") "for specifying the name of the version. The
corresponding value must be a regular expression which may contain
capture groups. In case" (:verb "pattern") "is used, project
versions specified in distribution recipes are scanned using the
regular expression and matching ones are considered existing
project versions. Within such a project version section, the
variables" (:verb "version-name") "," (:verb "match:0") ","
(:verb "match:1") "," (:verb "match:2") ", … are bound to the
whole matched string and the values of the capture groups in the
pattern respectively."
"For example, matching" (:verb "0.15-test") "against the
pattern" (:verb "^([0-9]+\.[0-9]+)-(.*)$") "results in bindings"
(:ul
(:verb "version-name → 0.15-test")
(:verb "match:0 → 0.15-test")
(:verb "match:1 → 0.15")
(:verb "match:2 → test"))
"These variables can be used in definitions of other variables in
the project version such as" (:verb "branch") "."
"Full example:"
(:verb "versions:
- pattern: '^(.*)-without-tests$'
variables:
branch: ${match:1}
cmake.options:
- '@{next-value}'
- -DBUILD_TESTS=false"))
(:enhancement
"Jobs and aspects defined in the orchestration context can now pick
up variable overwrites specified on the commandline.")
(:enhancement
"Most commands (notably " (:verb "generate") ") now work properly
when multiple distributions are specified in a single commandline
invocation of the program.")
(:enhancement
"When analyzing committers and commits in git repositories the
specified sub-directory, if any, is now considered.")
(:enhancement
"Recipes describing persons can now contain
a" (:verb "variables") "section.")
(:enhancement
"The new" (:verb "catalog") "report type outputs files in a format
that can be consumed by the citkat catalog server.")
(:enhancement
"When analyzing CMake projects, the project version can now be
determined when a" (:verb "PROJECT-NAMEConfigVersion.cmake.in")
"or" (:verb "PROJECT-NAME-config-version.cmake.in") "file refers to
a variable containing the project version.")
(:enhancement
"Error messages from access consistency checks display the
locations of the incompatible declarations, if possible."))
(:release "0.24" "2018-09-17"
(:incompatible-change
"The default of the" (:verb "--on-error") "commandline option is
now" (:verb "continue") "since the overwhelming majority of use
cases seem to mandate this value.")
(:enhancement
"When analyzing CMake projects," (:verb "include()") "commands are
now considered.")
(:enhancement
"When analyzing CMake projects, variable references are evaluated
more accurately and more efficiently.")
(:enhancement
"When analyzing CMake projects, the" (:verb "VERSION") "keyword of
the" (:verb "project()") "command is now considered.")
(:enhancement
"Unfulfilled dependencies are reported more compactly.")
(:enhancement
"The SonarCube Scanner plugin for standard build steps such as
Ant, Maven and Gradle is now supported.")
(:enhancement
"Boolean parameters for Jenkins jobs are now supported."))
(:release "0.23" "2018-07-20"
(:enhancement
"The YAML syntax for recipes now supports including other YAML
documents as well as text files:"
(:ul
("A tagged scalar node of the form"
(:verb "!b!include FILENAME")
"causes" (:verb "FILENAME") "to be loaded as a YAML file and
spliced into the current recipe, replacing the tagged scalar
node.")
("A tagged scalar node of the form"
(:verb "!b!literal-include FILENAME")
"causes" (:verb "FILENAME") "to be read as a string and spliced
into the current recipe, replacing the tagged scalar node.")))
(:enhancement
"Better error reports for syntax errors and missing templates in
YAML recipes.")
(:enhancement
"During the analysis phase, certain kinds of failed HTTP downloads
now lead to a limited number of retries instead of an immediate
failure.")
(:enhancement
"Errors during report generation are now reported with their own
error kind.")
(:enhancement
"Information for Gitea repositories can now be generated into the
configuration of the Jenkins Git plugin.")
(:enhancement
"The" (:verb "analyze") "command now handles URIs and filesystem
paths properly.")
(:enhancement
"A warning is no longer emitted when automatically switching from
JSON to YAML syntax for a recipe.")
(:bugfix
"A long-standing problem related non-ASCII characters in Jenkins
job data has been fixed by working around the way Jenkins handles
HTTP content types and XML encoding declarations.")
(:bugfix
"The" (:verb "temp-directory") "and" (:verb "cache-directory") "configuration
options are now explicitly interpreted as directory names. This
solves issues with directories specified without a trailing
\"/\"."))
(:release "0.22" "2018-06-08"
(:enhancement
"Recipes can now be written using YAML syntax following (mostly)
the same structural schema as before. As JSON is a subset of YAML,
the legacy JSON syntax and in particular existing recipes are
still supported. The following differences are noteworthy:"
(:ul
("Comments are now allowed and can be written as" (:verb "# comment"))
("Many string literals can be written in vastly improved manner:"
(:ul
"Quotes and escaping are not necessary in most cases"
"Multi-line strings pose no problems"
"A suitable interpretation of surrounding whitespace and
indentation can be specified as appropriate"))
("The" (:verb "name") "attribute is not allowed in project,
distribution and template recipes")
("The inclusion of projects in distributions can now be written in
several different ways:"
(:ul
("Old way for compatibility:"
(:verb "[ \"NAME\", VERSION₁, VERSION₂, …]") "where
each" (:verb "VERSION") "is either a string or"
(:verb "[ \"NAME\", { \"PARAMETER₁\": \"VALUE₁\", … } ]"))
("New way, compact:" (:verb "NAME@VERSION") "or"
(:verb "NAME … @VERSION") "to allow the"
(:verb "NAME₁ @VERSION₁
MUCH-LONGER-NAME₂ @VERSION₂")
"idiom")
("New way, single version with parameters:"
(:verb "name: NAME
version: VERSION
parameters:
PARAMETER₁: VALUE₁
PARAMETER₂: VALUE₂"))
("New way, multiple versions with or without parameters:"
(:verb "name: NAME
versions:
- version: VERSION₁
parameters:
PARAMETER₁₁: VALUE₁₁
PARAMETER₁₂: VALUE₁₂
- version: VERSION₂"))))
("Dependency specifications can now be written in several
different ways:"
(:ul
("Old way for compatibility:"
(:verb "[ \"NATURE\", \"TARGET\" ]") "or"
(:verb "[ \"NATURE\",\"TARGET\", VERSION ]") "where"
(:verb "VERSION") "is either a string or a list of version
component strings")
("New way:"
(:verb "nature: NATURE
target: TARGET
version: VERSION")
"where the" (:verb "version") "property is optional")))))
(:enhancement
"The new" (:verb "validate") "command checks the syntax and
referential integrity of recipes in a given recipe repository.")
(:enhancement
"Analysis results for projects using" (:variable "scm")
(:verb "archive") "can now be cached.")
(:enhancement
"Better error messages for missing or wrong arguments to
commandline options.")
(:enhancement
"More cases of ill-formed recipes are caught at parse-time.")
(:bugfix
"The" (:verb "trace-variable") "commandline option has been
restored.")
(:bugfix
"The" (:verb "generate") "command accepts a"
(:verb "-a API-TOKEN") "commandline argument like the old
commandline interface.")
(:bugfix
"Supplying single-value commandline options multiple times now
produces a suitable error message."))
(:release "0.21" "2018-05-07"
(:incompatible-change
"The commandline interface expects a sub-command that determines
what should be done (instead of always generating Jenkins
jobs). The previous behavior is mostly provided by the
\"generate\" command with some differences:"
(:ul
"The distribution(s) are now specified as positional arguments,
i.e. without \"-d\"."
"Platform requirements are neither checked nor reported. The new
\"platform-requirements\" command does that in a more sensible
way."
"It is no longer possible to generate jobs and reports in the same
invocation. The new \"report\" command is responsible for
generating reports.")
"Currently supported commands are:"
(:ul
(:verb "analyze Analyze project repositories w.r.t. dependencies and meta-data.")
(:verb "generate Generate Jenkins jobs for a given distribution.")
(:verb "help Print help either for all commands or for a given command.")
(:verb "info-aspects Print information about available aspects.")
(:verb "info-variables Print information about recognized variables.")
(:verb "platform-requirements Analyze system packages required on a given platform.")
(:verb "report Generate one or more reports for given distribution(s).")
(:verb "version Print the version of this program and some components.")))
(:incompatible-change
"The configuration schema changed, affecting environment variables
and the" (:file "build-generator.conf") "configuration file:"
(:ul
("The old" (:code "general") "section is now
called" (:code "global") ":"
(:ul
(:verb "general.cache-directory → global.cache-directory")
(:verb "general.temp-directory → global.temp-directory")
(:verb "general.num-processes → global.num-processes")
(:verb "general.progress-style → global.progress-style")))
("The old" (:code "jenkis") "section no longer exists. Most of its
options are now specific to the \"generate\" command:"
(:ul
(:verb "jenkins.base-uri → commands.generate.base-uri")
(:verb "jenkins.username → commands.generate.username")
(:verb "jenkins.password → commands.generate.password")
(:verb "jenkins.api-token → commands.generate.api-token")
(:verb "jenkins.delete-other → commands.generate.delete-other?")
(:verb "jenkins.delete-other-pattern → commands.generate.delete-other-pattern"))))
"Setting the environment
variable" (:code "BUILD_GENERATOR_CONFIG_DEBUG") "can help
debugging configuration problems.")
(:enhancement
"Source locations are reported for missing project files included
in distribution recipes.")
(:bugfix
"The" (:variable "recipe.maintainer") "variable is no longer
inherited from distributions in projects.")
(:enhancement
"The" (:variable "build-job.disabled?") "variable now accepts the
value" (:code "force-disabled") ".")
(:enhancement
"Upgrading cache entries written by an older generator version is
no longer treated as an error.")
(:enhancement
"Analysis of projects with" (:code "ros_package") "nature provides
Maven artifacts in the" (:code "org.ros.rosjava_messages") "group.")
(:enhancement
"The analysis of repository committers has been improved.")
(:enhancement
"Support for the mercurial version control system has been
improved.")
(:enhancement
"The new variable" (:variable "view.colums") "controls columns in
created views."))
(:release "0.20" "2018-03-02"
(:enhancement
"The" (:code "name") "property is now optional in all recipe
kinds (It has already been optional in template recipes).")
(:enhancement
"In distributions, variable references are expanded in included
project versions. However, the expression can only refer variables
defined directly in the distribution.")
(:enhancement
"References to non-existent project versions are reported with
source locations.")
(:enhancement
"When running interactively in a capable terminal, the \"one-line\"
progress style is used by default.")
(:bugfix
"The" (:code "mps") "analysis no longer gets confused by symbolic
links."))
(:release "0.19" "2018-02-15"
(:incompatible-change
"Generated Jenkins jobs for projects with
archive" (:variable "scm") "now respect the value of
the" (:variable "sub-directory") " variable properly. Recipes that
worked around this bug may have to be adjusted.")
(:enhancement
"Many recipe-related errors are now reported alongside an excerpt
from the file highlighting relevant source locations.")
(:enhancement
"When generating Jenkins jobs, the ability to communicate with the
specified Jenkins server is ensured before performing long-running
operations such as project analyses, failing early in case there
is a problem."))
(:release "0.18" "2018-01-02"
(:enhancement
"Versions defined in the" (:code "versions") "section of project
recipes can now overwrite more variables. In particular, the
following variables now work as expected in version blocks:"
(:ul
(:variable "repository")
(:variable "scm")
(:variable "scm.username")
(:variable "scm.password")
(:variable "sub-directory")
(:variable "branch")
(:variable "tag")
(:variable "commit")
(:variable "directory")
(:variable "natures")))
(:enhancement
"Jenkins' cross-site request forgery (CSRF) protection is now
supported.")
(:bugfix
"Updating permissions in generated Jenkins jobs now works
properly.")
(:enhancement
"The analysis of project licenses is now more robust and more
efficient.")
(:bugfix
"The analysis of projects with" (:code "cmake") "nature handles
sub-directories more robustly.")
(:enhancement
"A certain kind of Jetbrains MPS projects can now be analyzed using
the" (:code "mps") "nature.")))