Package io.github.gmazzo.codeowners
Interface CodeOwnersReports
-
- All Implemented Interfaces:
public interface CodeOwnersReports
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceCodeOwnersReports.Reportpublic interfaceCodeOwnersReports.HTMLReportpublic interfaceCodeOwnersReports.MappingsReportpublic enumCodeOwnersReports.Severity
-
Method Summary
Modifier and Type Method Description UnitfailOnUnowned()Fail the build if there are any unowned class files (same as setting failOnUnownedThresholdto0).UnitignoreUnowned()Never fail the build due to unowned class files (same as setting failOnUnownedThresholdto100).Unitmappings(Action<CodeOwnersReports.MappingsReport> action)Unithtml(Action<CodeOwnersReports.HTMLReport> action)Unitxml(Action<CodeOwnersReports.Report> action)Unitcheckstyle(Action<CodeOwnersReports.Report> action)Unitsarif(Action<CodeOwnersReports.Report> action)abstract Property<CodeOwnersReports.Severity>getUnownedClassSeverity()The severity level to report unowned class files. abstract Property<Float>getFailOnUnownedThreshold()The maximum percentage ( 0..100) of unowned class files allowed before the check fails.abstract CodeOwnersReports.MappingsReportgetMappings()abstract CodeOwnersReports.HTMLReportgetHtml()abstract CodeOwnersReports.ReportgetXml()abstract CodeOwnersReports.ReportgetCheckstyle()abstract CodeOwnersReports.ReportgetSarif()-
-
Method Detail
-
failOnUnowned
Unit failOnUnowned()
Fail the build if there are any unowned class files (same as setting
failOnUnownedThresholdto0).
-
ignoreUnowned
Unit ignoreUnowned()
Never fail the build due to unowned class files (same as setting
failOnUnownedThresholdto100).
-
mappings
Unit mappings(Action<CodeOwnersReports.MappingsReport> action)
-
html
Unit html(Action<CodeOwnersReports.HTMLReport> action)
-
xml
Unit xml(Action<CodeOwnersReports.Report> action)
-
checkstyle
Unit checkstyle(Action<CodeOwnersReports.Report> action)
-
sarif
Unit sarif(Action<CodeOwnersReports.Report> action)
-
getUnownedClassSeverity
@Input() abstract Property<CodeOwnersReports.Severity> getUnownedClassSeverity()
The severity level to report unowned class files. An entry will be added per each.
-
getFailOnUnownedThreshold
@Input()@Optional() abstract Property<Float> getFailOnUnownedThreshold()
The maximum percentage (
0..100) of unowned class files allowed before the check fails.0means no unowned files are allowed (default)100any number of files can be unowned (never fails)
-
getMappings
abstract CodeOwnersReports.MappingsReport getMappings()
-
getHtml
abstract CodeOwnersReports.HTMLReport getHtml()
-
getXml
abstract CodeOwnersReports.Report getXml()
-
getCheckstyle
abstract CodeOwnersReports.Report getCheckstyle()
-
getSarif
abstract CodeOwnersReports.Report getSarif()
-
-
-
-