forked from anchore/scan-action
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
5701 lines (5243 loc) · 182 KB
/
index.js
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
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module.exports =
/******/ (() => { // webpackBootstrap
/******/ var __webpack_modules__ = ({
/***/ 932:
/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
const cache = __webpack_require__(784);
const core = __webpack_require__(186);
const { exec } = __webpack_require__(514);
const fs = __webpack_require__(747);
const stream = __webpack_require__(413);
const grypeBinary = "grype";
const grypeVersion = "0.22.0";
// sarif code
function convert_severity_to_acs_level(input_severity, severity_cutoff_param) {
// The `severity_cutoff_param` has been lowercased for case-insensitivity at this point, but the
// severity from the vulnerability will be capitalized, so this must be capitalized again to calculate
// using the same object
let param =
severity_cutoff_param[0].toUpperCase() + severity_cutoff_param.substring(1);
var ret = "error";
const severityLevels = {
Unknown: 0,
Negligible: 1,
Low: 2,
Medium: 3,
High: 4,
Critical: 5,
};
if (severityLevels[input_severity] < severityLevels[param]) {
ret = "warning";
}
return ret;
}
function getLocation(v) {
if (v.artifact.locations.length) {
// If the scan was against a directory, the location will be a string
var location = v.artifact.locations[0];
if (typeof location === "string") {
return location;
}
// Otherwise it is an object with "path" and "layer" keys
return location["path"];
}
// XXX there is room for improvement here, trying to mimick previous behavior
// If no `dockerfile-path` was provided, and in the improbable situation where there
// are no locations for the artifact, return 'Dockerfile'
return "Dockerfile";
}
function textMessage(v) {
const path = getLocation(v);
var scheme = sourceScheme();
let prefix = `The path ${path} reports ${v.artifact.name} at version ${v.artifact.version} `;
if (["dir", "tar"].includes(scheme)) {
return `${prefix} which would result in a vulnerable (${v.artifact.type}) package installed`;
} else {
return `${prefix} which is a vulnerable (${v.artifact.type}) package installed in the container`;
}
}
function dottedQuadFileVersion(version) {
// The dotted quad version requirements of the SARIF schema has some strict requirements. Because
// it is tied to the version which can be (optionally) set by the user, it isn't enough to blindly
// add a trailing ".0" - This function validates the end result, falling back to a version that would
// pass the schema while issuing a warning.
const pattern = /[0-9]+(\.[0-9]+){3}/;
// grype has some releases with dashes, ensure these are pruned
version = version.split("-")[0];
// None of the Grype versions will ever have version with four parts, add a trailing `.0` here
version = version + ".0";
if (!version.match(pattern)) {
// After prunning and adding a trailing .0 we still got a failure. Warn about this, and fallback to
// a made-up version guaranteed to work.
core.warning(
`Unable to produce an acceptable four-part dotted version: ${version} \n` +
`SARIF reporting requires pattern matching against "[0-9]+(\\.[0-9]+){3}" \n` +
"Will fallback to 0.0.0.0"
);
return "0.0.0.0";
}
return version;
}
function get_fix_versions(v) {
if (
v.vulnerability.fix &&
v.vulnerability.fix.state === "fixed" &&
v.vulnerability.fix.versions &&
v.vulnerability.fix.versions.length > 0
) {
return v.vulnerability.fix.versions.join(",");
}
return "";
}
function make_subtitle(v) {
let subtitle = `${v.vulnerability.description}`;
if (subtitle != "undefined") {
return subtitle;
}
const fixVersions = get_fix_versions(v);
if (fixVersions) {
return `Version ${v.artifact.version} is affected with an available fix in versions ${fixVersions}`;
}
return `Version ${v.artifact.version} is affected with no fixes reported yet.`;
}
function grype_render_rules(vulnerabilities, source) {
var ret = {};
let scheme = sourceScheme();
if (vulnerabilities) {
let ruleIDs = [];
// This uses .reduce() because there can be duplicate vulnerabilities which the SARIF schema complains about.
ret = vulnerabilities.reduce(function (result, v) {
let ruleID = `ANCHOREVULN_${v.vulnerability.id}_${v.artifact.type}_${v.artifact.name}_${v.artifact.version}`;
if (scheme == "docker") {
// include the container as part of the rule id so that users can sort by that
ruleID = `ANCHOREVULN_${source}_${v.vulnerability.id}_${v.artifact.type}_${v.artifact.name}_${v.artifact.version}`;
}
if (!ruleIDs.includes(ruleID)) {
ruleIDs.push(ruleID);
// Entirely possible to not have any links whatsoever
let link = v.vulnerability.id;
if ("dataSource" in v.vulnerability) {
link = `[${v.vulnerability.id}](${v.vulnerability.dataSource})`;
} else if (
"urls" in v.vulnerability &&
v.vulnerability.urls.length > 0
) {
link = `[${v.vulnerability.id}](${v.vulnerability.urls[0]})`;
}
result.push({
id: ruleID,
// Title of the SARIF report
shortDescription: {
text: `${v.vulnerability.id} ${v.vulnerability.severity} vulnerability for ${v.artifact.name} package`,
},
// Subtitle of the SARIF report
fullDescription: {
text: make_subtitle(v),
},
help: {
text:
"Vulnerability " +
v.vulnerability.id +
"\n" +
"Severity: " +
v.vulnerability.severity +
"\n" +
"Package: " +
v.artifact.name +
"\n" +
"Version: " +
v.artifact.version +
"\n" +
"Fix Version: " +
(get_fix_versions(v) || "none") +
"\n" +
"Type: " +
v.artifact.type +
"\n" +
"Location: " +
v.artifact.locations[0].path +
"\n" +
//"Data Namespace: "+v.vulnerability.matched_by.matcher +"\n"+
"Data Namespace: " +
"unknown" +
"\n" +
`Link: ${link}`,
markdown:
"**Vulnerability " +
v.vulnerability.id +
"**\n" +
"| Severity | Package | Version | Fix Version | Type | Location | Data Namespace | Link |\n" +
"| --- | --- | --- | --- | --- | --- | --- | --- |\n" +
"|" +
v.vulnerability.severity +
"|" +
v.artifact.name +
"|" +
v.artifact.version +
"|" +
(get_fix_versions(v) || "none") +
"|" +
v.artifact.type +
"|" +
v.artifact.locations[0].path +
"|" +
"unknown" +
"|" +
link +
"|\n",
},
});
}
return result;
}, []);
}
return ret;
}
function grype_render_results(vulnerabilities, severity_cutoff_param, source) {
var ret = {};
let scheme = sourceScheme();
if (vulnerabilities) {
ret = vulnerabilities.map((v) => {
let ruleid = `ANCHOREVULN_${v.vulnerability.id}_${v.artifact.type}_${v.artifact.name}_${v.artifact.version}`;
if (scheme == "docker") {
// include the container as part of the rule id so that users can sort by that
ruleid = `ANCHOREVULN_${source}_${v.vulnerability.id}_${v.artifact.type}_${v.artifact.name}_${v.artifact.version}`;
}
return {
ruleId: ruleid,
ruleIndex: 0,
level: convert_severity_to_acs_level(
v.vulnerability.severity,
severity_cutoff_param
),
message: {
text: textMessage(v),
id: "default",
},
analysisTarget: {
uri: getLocation(v),
// XXX This is possibly a bug. The SARIF schema invalidates this when the index is present because there
// aren't any other elements present.
//"index": 0
},
locations: [
{
physicalLocation: {
artifactLocation: {
uri: getLocation(v),
},
// TODO: When grype starts reporting line numbers this will need to get updated
region: {
startLine: 1,
startColumn: 1,
endLine: 1,
endColumn: 1,
byteOffset: 1,
byteLength: 1,
},
},
logicalLocations: [
{
fullyQualifiedName: "dockerfile",
},
],
},
],
suppressions: [
{
kind: "external",
},
],
baselineState: "unchanged",
};
});
}
return ret;
}
function vulnerabilities_to_sarif(
grypeVulnerabilities,
severity_cutoff_param,
version,
source
) {
let vulnerabilities = grypeVulnerabilities.matches;
const sarifOutput = {
$schema:
"https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.4.json",
version: "2.1.0",
runs: [
{
tool: {
driver: {
name: "Anchore Container Vulnerability Report (T0)",
fullName: "Anchore Container Vulnerability Report (T0)",
version: version,
semanticVersion: version,
dottedQuadFileVersion: dottedQuadFileVersion(version),
rules: grype_render_rules(vulnerabilities, source),
},
},
logicalLocations: [
{
name: "dockerfile",
fullyQualifiedName: "dockerfile",
kind: "namespace",
},
],
results: grype_render_results(
vulnerabilities,
severity_cutoff_param,
source
),
columnKind: "utf16CodeUnits",
},
],
};
return sarifOutput;
}
// Find all 'content-*.json' files in the directory. dirname should include the full path
function findContent(searchDir) {
let contentFiles = [];
let match = /content-.*\.json/;
var dirItems = fs.readdirSync(searchDir);
if (dirItems) {
for (let i = 0; i < dirItems.length; i++) {
if (match.test(dirItems[i])) {
contentFiles.push(`${searchDir}/${dirItems[i]}`);
}
}
} else {
core.debug("no dir content found");
}
core.debug(contentFiles.toString());
return contentFiles;
}
// Load the json content of each file in a list and return them as a list
function loadContent(files) {
let contents = [];
if (files) {
files.forEach((item) => contents.push(JSON.parse(fs.readFileSync(item))));
}
return contents;
}
// Merge the multiple content output types into a single array
function mergeResults(contentArray) {
return contentArray.reduce((merged, n) => merged.concat(n.content), []);
}
async function downloadGrype(version) {
let url = `https://raw.githubusercontent.com/anchore/grype/main/install.sh`;
core.debug(`Installing ${version}`);
// TODO: when grype starts supporting unreleased versions, support it here
// Download the installer, and run
const installPath = await cache.downloadTool(url);
// Make sure the tool's executable bit is set
await exec(`chmod +x ${installPath}`);
let cmd = `${installPath} -b ${installPath}_grype v${version}`;
await exec(cmd);
let grypePath = `${installPath}_grype/grype`;
// Cache the downloaded file
return cache.cacheFile(grypePath, `grype`, `grype`, version);
}
async function installGrype(version) {
let grypePath = cache.find(grypeBinary, version);
if (!grypePath) {
// Not found, install it
grypePath = await downloadGrype(version);
}
// Add tool to path for this and future actions to use
core.addPath(grypePath);
}
function sourceScheme() {
// This potentially can be removed once grype starts reporting what it used to perform the scan
// in the JSON output
// Any newer schemes like OCI need to be added here
if (core.getInput("image") != "") {
return "docker";
}
// Only two options are currently supported
return "dir";
}
function sourceInput() {
var image = core.getInput("image");
var path = core.getInput("path");
if (image && path) {
throw new Error("Cannot use both 'image' and 'path' as sources");
}
if (!(image || path)) {
throw new Error(
"At least one source for scanning needs to be provided. Available options are: image, and path"
);
}
if (image != "") {
return image;
}
return "dir:" + path;
}
async function run() {
try {
core.debug(new Date().toTimeString());
// Grype accepts several input options, initially this action is supporting both `image` and `path`, so
// a check must happen to ensure one is selected at least, and then return it
const source = sourceInput();
const debug = core.getInput("debug");
const failBuild = core.getInput("fail-build");
const acsReportEnable = core.getInput("acs-report-enable");
const severityCutoff = core.getInput("severity-cutoff");
const out = await runScan({
source,
debug,
failBuild,
acsReportEnable,
severityCutoff,
});
Object.keys(out).map((key) => {
core.setOutput(key, out[key]);
});
} catch (error) {
core.setFailed(error.message);
}
}
async function runScan({
source,
debug = "false",
failBuild = "true",
acsReportEnable = "true",
severityCutoff = "medium",
}) {
const out = {};
const SEVERITY_LIST = ["negligible", "low", "medium", "high", "critical"];
let cmdArgs = [];
if (debug.toLowerCase() === "true") {
debug = "true";
cmdArgs = [`-vv`, `-o`, `json`];
} else {
debug = "false";
cmdArgs = [`-o`, `json`];
}
if (failBuild.toLowerCase() === "true") {
failBuild = true;
} else {
failBuild = false;
}
if (acsReportEnable.toLowerCase() === "true") {
acsReportEnable = true;
} else {
acsReportEnable = false;
}
if (
!SEVERITY_LIST.some(
(item) =>
typeof severityCutoff.toLowerCase() === "string" &&
item === severityCutoff.toLowerCase()
)
) {
throw new Error(
`Invalid severity-cutoff value is set to ${severityCutoff} - please ensure you are choosing either negligible, low, medium, high, or critical`
);
}
core.debug(`Installing grype version ${grypeVersion}`);
await installGrype(grypeVersion);
core.debug("Image: " + source);
core.debug("Debug Output: " + debug);
core.debug("Fail Build: " + failBuild);
core.debug("Severity Cutoff: " + severityCutoff);
core.debug("ACS Enable: " + acsReportEnable);
core.debug("Creating options for GRYPE analyzer");
// Run the grype analyzer
let cmdOutput = "";
let cmd = `${grypeBinary}`;
if (severityCutoff != "") {
cmdArgs.push("--fail-on");
cmdArgs.push(severityCutoff.toLowerCase());
}
cmdArgs.push(source);
// This /dev/null writable stream is required so the entire Grype output
// is not written to the GitHub action log. the listener below
// will actually capture the output
const outStream = new stream.Writable({
write(buffer, encoding, next) {
next();
},
});
const cmdOpts = {
ignoreReturnCode: true,
outStream,
listeners: {
stdout: (data = Buffer) => {
cmdOutput += data.toString();
},
},
};
core.info("\nAnalyzing: " + source);
core.info(`Executing: ${cmd} ` + cmdArgs.join(" "));
const exitCode = await exec(cmd, cmdArgs, cmdOpts);
if (core.isDebug()) {
core.debug("Grype output:");
core.debug(cmdOutput);
}
let grypeVulnerabilities;
try {
grypeVulnerabilities = JSON.parse(cmdOutput);
} catch (e) {
core.error(`Unable to parse grype output: ${e}`);
core.error(cmdOutput);
}
if (acsReportEnable) {
try {
const serifOut = sarifGrypeGeneration(
grypeVulnerabilities,
severityCutoff.toLowerCase(),
grypeVersion,
source
);
Object.assign(out, serifOut);
} catch (err) {
throw new Error(err);
}
}
if (failBuild === true && exitCode > 0) {
core.setFailed(
`Failed minimum severity level. Found vulnerabilities with level ${severityCutoff} or higher`
);
}
// If there is a non-zero exit status code there are a couple of potential reporting paths
if (failBuild === false && exitCode > 0) {
// There was a non-zero exit status but it wasn't because of failing severity, this must be
// a grype problem
if (!severityCutoff) {
core.warning("grype had a non-zero exit status when running");
} else {
// There is a non-zero exit status code with severity cut off, although there is still a chance this is grype
// that is broken, it will most probably be a failed severity. Using warning here will make it bubble up in the
// Actions UI
core.warning(
`Failed minimum severity level. Found vulnerabilities with level ${severityCutoff} or higher`
);
}
}
return out;
}
function sarifGrypeGeneration(
grypeVulnerabilities,
severity_cutoff_param,
version,
source
) {
// sarif generate section
const SARIF_FILE = "./results.sarif";
let sarifOutput = vulnerabilities_to_sarif(
grypeVulnerabilities,
severity_cutoff_param,
version,
source
);
fs.writeFileSync(SARIF_FILE, JSON.stringify(sarifOutput, null, 2));
return {
sarif: SARIF_FILE,
};
// end sarif generate section
}
module.exports = {
run,
runScan,
installGrype,
mergeResults,
findContent,
loadContent,
vulnerabilities_to_sarif,
convert_severity_to_acs_level,
};
if (require.main === require.cache[eval('__filename')]) {
run().catch((err) => {
throw new Error(err);
});
}
/***/ }),
/***/ 351:
/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
"use strict";
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
Object.defineProperty(exports, "__esModule", ({ value: true }));
const os = __importStar(__webpack_require__(87));
const utils_1 = __webpack_require__(278);
/**
* Commands
*
* Command Format:
* ::name key=value,key=value::message
*
* Examples:
* ::warning::This is the message
* ::set-env name=MY_VAR::some value
*/
function issueCommand(command, properties, message) {
const cmd = new Command(command, properties, message);
process.stdout.write(cmd.toString() + os.EOL);
}
exports.issueCommand = issueCommand;
function issue(name, message = '') {
issueCommand(name, {}, message);
}
exports.issue = issue;
const CMD_STRING = '::';
class Command {
constructor(command, properties, message) {
if (!command) {
command = 'missing.command';
}
this.command = command;
this.properties = properties;
this.message = message;
}
toString() {
let cmdStr = CMD_STRING + this.command;
if (this.properties && Object.keys(this.properties).length > 0) {
cmdStr += ' ';
let first = true;
for (const key in this.properties) {
if (this.properties.hasOwnProperty(key)) {
const val = this.properties[key];
if (val) {
if (first) {
first = false;
}
else {
cmdStr += ',';
}
cmdStr += `${key}=${escapeProperty(val)}`;
}
}
}
}
cmdStr += `${CMD_STRING}${escapeData(this.message)}`;
return cmdStr;
}
}
function escapeData(s) {
return utils_1.toCommandValue(s)
.replace(/%/g, '%25')
.replace(/\r/g, '%0D')
.replace(/\n/g, '%0A');
}
function escapeProperty(s) {
return utils_1.toCommandValue(s)
.replace(/%/g, '%25')
.replace(/\r/g, '%0D')
.replace(/\n/g, '%0A')
.replace(/:/g, '%3A')
.replace(/,/g, '%2C');
}
//# sourceMappingURL=command.js.map
/***/ }),
/***/ 186:
/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
Object.defineProperty(exports, "__esModule", ({ value: true }));
const command_1 = __webpack_require__(351);
const file_command_1 = __webpack_require__(717);
const utils_1 = __webpack_require__(278);
const os = __importStar(__webpack_require__(87));
const path = __importStar(__webpack_require__(622));
/**
* The code to exit an action
*/
var ExitCode;
(function (ExitCode) {
/**
* A code indicating that the action was successful
*/
ExitCode[ExitCode["Success"] = 0] = "Success";
/**
* A code indicating that the action was a failure
*/
ExitCode[ExitCode["Failure"] = 1] = "Failure";
})(ExitCode = exports.ExitCode || (exports.ExitCode = {}));
//-----------------------------------------------------------------------
// Variables
//-----------------------------------------------------------------------
/**
* Sets env variable for this action and future actions in the job
* @param name the name of the variable to set
* @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function exportVariable(name, val) {
const convertedVal = utils_1.toCommandValue(val);
process.env[name] = convertedVal;
const filePath = process.env['GITHUB_ENV'] || '';
if (filePath) {
const delimiter = '_GitHubActionsFileCommandDelimeter_';
const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
file_command_1.issueCommand('ENV', commandValue);
}
else {
command_1.issueCommand('set-env', { name }, convertedVal);
}
}
exports.exportVariable = exportVariable;
/**
* Registers a secret which will get masked from logs
* @param secret value of the secret
*/
function setSecret(secret) {
command_1.issueCommand('add-mask', {}, secret);
}
exports.setSecret = setSecret;
/**
* Prepends inputPath to the PATH (for this action and future actions)
* @param inputPath
*/
function addPath(inputPath) {
const filePath = process.env['GITHUB_PATH'] || '';
if (filePath) {
file_command_1.issueCommand('PATH', inputPath);
}
else {
command_1.issueCommand('add-path', {}, inputPath);
}
process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`;
}
exports.addPath = addPath;
/**
* Gets the value of an input. The value is also trimmed.
*
* @param name name of the input to get
* @param options optional. See InputOptions.
* @returns string
*/
function getInput(name, options) {
const val = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '';
if (options && options.required && !val) {
throw new Error(`Input required and not supplied: ${name}`);
}
return val.trim();
}
exports.getInput = getInput;
/**
* Sets the value of an output.
*
* @param name name of the output to set
* @param value value to store. Non-string values will be converted to a string via JSON.stringify
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function setOutput(name, value) {
command_1.issueCommand('set-output', { name }, value);
}
exports.setOutput = setOutput;
/**
* Enables or disables the echoing of commands into stdout for the rest of the step.
* Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set.
*
*/
function setCommandEcho(enabled) {
command_1.issue('echo', enabled ? 'on' : 'off');
}
exports.setCommandEcho = setCommandEcho;
//-----------------------------------------------------------------------
// Results
//-----------------------------------------------------------------------
/**
* Sets the action status to failed.
* When the action exits it will be with an exit code of 1
* @param message add error issue message
*/
function setFailed(message) {
process.exitCode = ExitCode.Failure;
error(message);
}
exports.setFailed = setFailed;
//-----------------------------------------------------------------------
// Logging Commands
//-----------------------------------------------------------------------
/**
* Gets whether Actions Step Debug is on or not
*/
function isDebug() {
return process.env['RUNNER_DEBUG'] === '1';
}
exports.isDebug = isDebug;
/**
* Writes debug message to user log
* @param message debug message
*/
function debug(message) {
command_1.issueCommand('debug', {}, message);
}
exports.debug = debug;
/**
* Adds an error issue
* @param message error issue message. Errors will be converted to string via toString()
*/
function error(message) {
command_1.issue('error', message instanceof Error ? message.toString() : message);
}
exports.error = error;
/**
* Adds an warning issue
* @param message warning issue message. Errors will be converted to string via toString()
*/
function warning(message) {
command_1.issue('warning', message instanceof Error ? message.toString() : message);
}
exports.warning = warning;
/**
* Writes info to log with console.log.
* @param message info message
*/
function info(message) {
process.stdout.write(message + os.EOL);
}
exports.info = info;
/**
* Begin an output group.
*
* Output until the next `groupEnd` will be foldable in this group
*
* @param name The name of the output group
*/
function startGroup(name) {
command_1.issue('group', name);
}
exports.startGroup = startGroup;
/**
* End an output group.
*/
function endGroup() {
command_1.issue('endgroup');
}
exports.endGroup = endGroup;
/**
* Wrap an asynchronous function call in a group.
*
* Returns the same type as the function itself.
*
* @param name The name of the group
* @param fn The function to wrap in the group
*/
function group(name, fn) {
return __awaiter(this, void 0, void 0, function* () {
startGroup(name);
let result;
try {
result = yield fn();
}
finally {
endGroup();
}
return result;
});
}
exports.group = group;
//-----------------------------------------------------------------------
// Wrapper action state
//-----------------------------------------------------------------------
/**
* Saves state for current action, the state can only be retrieved by this action's post job execution.
*
* @param name name of the state to store
* @param value value to store. Non-string values will be converted to a string via JSON.stringify
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function saveState(name, value) {
command_1.issueCommand('save-state', { name }, value);
}
exports.saveState = saveState;
/**
* Gets the value of an state set by this action's main execution.
*
* @param name name of the state to get
* @returns string
*/
function getState(name) {
return process.env[`STATE_${name}`] || '';
}
exports.getState = getState;
//# sourceMappingURL=core.js.map
/***/ }),
/***/ 717:
/***/ (function(__unused_webpack_module, exports, __webpack_require__) {
"use strict";
// For internal use, subject to change.
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
Object.defineProperty(exports, "__esModule", ({ value: true }));
// We use any as a valid input type
/* eslint-disable @typescript-eslint/no-explicit-any */
const fs = __importStar(__webpack_require__(747));
const os = __importStar(__webpack_require__(87));
const utils_1 = __webpack_require__(278);
function issueCommand(command, message) {
const filePath = process.env[`GITHUB_${command}`];
if (!filePath) {
throw new Error(`Unable to find environment variable for file command ${command}`);
}
if (!fs.existsSync(filePath)) {
throw new Error(`Missing file at path: ${filePath}`);
}
fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, {
encoding: 'utf8'
});
}
exports.issueCommand = issueCommand;
//# sourceMappingURL=file-command.js.map
/***/ }),
/***/ 278:
/***/ ((__unused_webpack_module, exports) => {
"use strict";
// We use any as a valid input type
/* eslint-disable @typescript-eslint/no-explicit-any */
Object.defineProperty(exports, "__esModule", ({ value: true }));
/**
* Sanitizes an input into a string so it can be passed into issueCommand safely