Skip to content

Commit f891370

Browse files
committed
Add some docs to some newer overlay Features
To make it easier to see what they do at a glance
1 parent 23b3891 commit f891370

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/feature-flags.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,22 @@ export enum Feature {
6262
OverlayAnalysisCodeScanningSwift = "overlay_analysis_code_scanning_swift",
6363
OverlayAnalysisCpp = "overlay_analysis_cpp",
6464
OverlayAnalysisCsharp = "overlay_analysis_csharp",
65+
/** Controls whether the Actions cache is checked for overlay build outcomes. */
6566
OverlayAnalysisStatusCheck = "overlay_analysis_status_check",
67+
/** Controls whether overlay build failures on are stored in the Actions cache. */
6668
OverlayAnalysisStatusSave = "overlay_analysis_status_save",
6769
OverlayAnalysisGo = "overlay_analysis_go",
6870
OverlayAnalysisJava = "overlay_analysis_java",
6971
OverlayAnalysisJavascript = "overlay_analysis_javascript",
7072
OverlayAnalysisPython = "overlay_analysis_python",
73+
/**
74+
* Controls whether lower disk space requirements are used for overlay hardware checks.
75+
* Has no effect if `OverlayAnalysisSkipResourceChecks` is enabled.
76+
*/
7177
OverlayAnalysisResourceChecksV2 = "overlay_analysis_resource_checks_v2",
7278
OverlayAnalysisRuby = "overlay_analysis_ruby",
7379
OverlayAnalysisRust = "overlay_analysis_rust",
80+
/** Controls whether hardware checks are skipped for overlay analysis. */
7481
OverlayAnalysisSkipResourceChecks = "overlay_analysis_skip_resource_checks",
7582
OverlayAnalysisSwift = "overlay_analysis_swift",
7683
PythonDefaultIsToNotExtractStdlib = "python_default_is_to_not_extract_stdlib",

0 commit comments

Comments
 (0)