StigGenerateMarkdownTask

@DisableCachingByDefault(because = "Generates documentation in place; not audited for cache correctness.")
abstract class StigGenerateMarkdownTask : DefaultTask

Generates Markdown documentation for a single element (viewpoint pages, metric tables, direct P7 diagram links, and known-gap sections).

Up-to-date capable: declares @OutputFile / @OutputDirectory outputs. If model classes, metric reports, and configuration inputs are unchanged, Gradle skips re-execution.

Not cacheable: generates documentation files in place. Not yet audited for cache correctness — output depends on many dynamic inputs (diagram files, metric reports, compiled model state) whose path-sensitivity annotations have not been fully verified.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open var actions: List<Action<in Task?>?>?
Link copied to clipboard
@get:Input
@get:Optional
abstract val analysisViewpoint: Property<String>
Link copied to clipboard
open val ant: AntBuilder?
Link copied to clipboard
@get:Internal
open val asDynamicObject: DynamicObject
Link copied to clipboard
open val dependsOn: Set<Any?>?
Link copied to clipboard
open var description: @Nullable String?
Link copied to clipboard
open val destroyables: TaskDestroyables?
Link copied to clipboard
open var didWork: Boolean
Link copied to clipboard
@get:Internal
abstract val docsProjectDir: DirectoryProperty
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceCodeBrowser: Property<String>
Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceCommit: Property<String>
Link copied to clipboard
@get:OutputFile
@get:Optional
abstract val dokkaBuildProvenanceFile: RegularFileProperty
Link copied to clipboard
@get:Internal
abstract val dokkaBuildProvenanceGitRoot: DirectoryProperty

Root of the git repository that contains this module's sources. Used together with projectRoot to compute the path prefix from git root to project root so that GitHub blob URLs in check-results tables point to the correct location (e.g. models/stig-project/activities/...).

Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceGitRootPath: Property<String>

Path of the git repository root that contains this module's sources. Used together with projectRoot to compute source-link path prefixes. Tracked as a scalar path for the same reason as dokkaBuildProvenanceRepositoryRootPath.

Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceModuleName: Property<String>
Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceProjectRootPath: Property<String>

Project checkout root whose provenance row may receive authoritative CI review metadata.

Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceProjectVersion: Property<String>

Consumer project version (e.g. "1.2.3" or "1.2.3-SNAPSHOT").

Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceRemotePath: Property<String>
Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceRemoteUrl: Property<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoBranches: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoCodeBrowsers: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoCommitModes: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoCommits: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoEditRefs: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoIdeaOrigins: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoNames: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoRemotePaths: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoRemoteUrls: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceRepoRoots: ListProperty<String>
Link copied to clipboard
@get:Internal
abstract val dokkaBuildProvenanceRepositoryRoot: DirectoryProperty
Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceRepositoryRootPath: Property<String>

Path of the git repository root used for fallback provenance. This is tracked as a scalar path, not as an input directory: the task reads git metadata from this location, but it must not scan the whole checkout and accidentally consume other tasks' build outputs under it.

Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceReviewLabel: Property<String>
Link copied to clipboard
@get:Input
abstract val dokkaBuildProvenanceReviewUrl: Property<String>
Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaBuildProvenanceStigVersion: Property<String>

STIG plugin version (e.g. "1.1.0" or "dev").

Link copied to clipboard
@get:Input
abstract val dokkaModelModuleNames: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val dokkaModelPreviewDirectories: MapProperty<String, String>

Actual publication directories and module names, including referenced modules in a local preview.

Link copied to clipboard
@get:Input
abstract val dokkaModulePreviewMode: Property<Boolean>

When true, image-asset paths are computed for the Dokka module-preview layout (build/dokka/module-preview/) where the module name is a single flat directory (dots preserved), instead of the aggregate layout where dots become nested directories. Defaults to false (aggregate mode).

Link copied to clipboard
@get:Input
@get:Optional
abstract val dokkaPackagePrefix: Property<String>

Package prefix combined with dokkaBuildProvenanceModuleName and the viewpoint name to identify report assets uniquely across modules. Package includes use the module's source package directories, independently of its Gradle path.

Link copied to clipboard
@get:Input
abstract val dokkaPublishedModules: ListProperty<String>

Modules whose model pages exist in the selected HTML publication.

Link copied to clipboard
@get:InputFiles
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val dokkaSourceRoots: ConfigurableFileCollection

Module source-tree roots scanned by the scaffold pass for per-package Markdown headers (# Package X). Typical values: this module's src/main/kotlin and stig/src/main/kotlin. Empty / unset means scaffold-writing is a no-op.

Link copied to clipboard
@get:Input
abstract val editSourceLinks: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val elementDir: DirectoryProperty
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
@get:Input
abstract val enableModelListings: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val explicitContextModules: ListProperty<String>
Link copied to clipboard
open val extensions: ExtensionContainer?
Link copied to clipboard
open val finalizedBy: TaskDependency?
Link copied to clipboard
@get:Input
abstract val format: Property<DocsFormat>
Link copied to clipboard
@get:Input
abstract val generatedSourceRoots: ListProperty<String>

Generated roots have local IDEA links, never links to nonexistent Git source files.

Link copied to clipboard
open var group: @Nullable String?
Link copied to clipboard
@get:Input
abstract val ideaSourceLinks: Property<Boolean>
Link copied to clipboard
open val identityPath: Path?
Link copied to clipboard
Link copied to clipboard
@get:Input
abstract val includeBuildProvenanceInDokka: Property<Boolean>
Link copied to clipboard
open val inputs: TaskInputsInternal?
Link copied to clipboard
@get:Internal
open var isEnabled: Boolean
Link copied to clipboard
Link copied to clipboard
@get:OutputFile
abstract val issuesInventoryFile: RegularFileProperty
Link copied to clipboard
@get:OutputFile
abstract val issuesMarkdownFile: RegularFileProperty
Link copied to clipboard
@get:Internal
open val lifecycleDependencies: TaskDependencyInternal?
Link copied to clipboard
open val localState: TaskLocalState?
Link copied to clipboard
open val logger: Logger?
Link copied to clipboard
open val logging: LoggingManager?
Link copied to clipboard
open val loggingManager: @Nullable LoggingManagerInternal?
Link copied to clipboard
@get:Input
abstract val logicalOwnerProjects: MapProperty<String, String>
Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val modelCheckProblemsFile: RegularFileProperty

Canonical model problems from stigCheckModel, used directly by HTML rendering.

Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val modelCheckRuleInventoryFile: RegularFileProperty

Model-check inventory used to render invocation and result counts without reading derived SARIF.

Link copied to clipboard
@get:Classpath
abstract val modelClasspath: ConfigurableFileCollection
Link copied to clipboard
@get:Input
abstract val modelLibrary: Property<Boolean>

Libraries have declaration documentation but no architectural CREATE viewpoint pages.

Link copied to clipboard
@get:Input
abstract val modelModuleDirectories: MapProperty<String, String>
Link copied to clipboard
@get:Input
abstract val modelModulePath: Property<String>
Link copied to clipboard
@get:Classpath
abstract val modelOutputClasspath: ConfigurableFileCollection
Link copied to clipboard
open val mustRunAfter: TaskDependency?
Link copied to clipboard
open val name: String?
Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val navigationFile: RegularFileProperty
Link copied to clipboard
open val onlyIf: Spec<in TaskInternal?>?
Link copied to clipboard
@get:OutputDirectory
abstract val outputDir: DirectoryProperty
Link copied to clipboard
open val outputs: TaskOutputsInternal?
Link copied to clipboard
open val path: String?
Link copied to clipboard
@get:InputFile
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val preparedModelReportIndexFile: RegularFileProperty

Shared report preparation supplies locations and issues without loading the model again.

Link copied to clipboard
@get:InputFiles
@get:Optional
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val problemsFiles: ConfigurableFileCollection

Canonical task problem logs emitted by com.stigway.gradle.support.GradleStigProblemReporter. These are rendered on the activity root page as a separate task-problems table.

Link copied to clipboard
open val project: Project?
Link copied to clipboard
@get:Internal
abstract val projectRoot: DirectoryProperty
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val requiredServices: TaskRequiredServices?
Link copied to clipboard
open val sharedResources: List<ResourceLock?>?
Link copied to clipboard
open val shouldRunAfter: TaskDependency?
Link copied to clipboard
open val standardOutputCapture: StandardOutputCapture?
Link copied to clipboard
open val state: TaskStateInternal?
Link copied to clipboard
open val taskActions: List<InputChangesAwareTaskAction?>?
Link copied to clipboard
open val taskDependencies: TaskDependencyInternal?
Link copied to clipboard
open val taskIdentity: TaskIdentity<*>?
Link copied to clipboard
open val temporaryDir: File?
Link copied to clipboard
open val temporaryDirFactory: Factory<File?>?
Link copied to clipboard
open val timeout: Property<Duration?>?
Link copied to clipboard
@get:Input
abstract val updateNavigation: Property<Boolean>
Link copied to clipboard
@get:Input
abstract val viewpoints: ListProperty<String>
Link copied to clipboard
@get:Input
abstract val viewSourceLinks: Property<Boolean>

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open operator fun compareTo(otherTask: Task?): Int
Link copied to clipboard
open fun configure(closure: Closure<*>?): Task?
Link copied to clipboard
open fun dependsOn(vararg paths: Any?): Task?
Link copied to clipboard
open fun doFirst(action: Closure<*>?): Task?
open fun doFirst(action: Action<in Task?>?): Task?
open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doLast(action: Closure<*>?): Task?
open fun doLast(action: Action<in Task?>?): Task?
open fun doLast(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String?)
Link copied to clipboard
open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun finalizedBy(vararg paths: Any?): Task?
Link copied to clipboard
open fun hasProperty(propertyName: String?): Boolean
Link copied to clipboard
Link copied to clipboard
open fun mustRunAfter(vararg paths: Any?): Task?
Link copied to clipboard
open fun onlyIf(onlyIfClosure: Closure<*>?)
open fun onlyIf(spec: Spec<in Task?>?)
open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)
Link copied to clipboard
Link copied to clipboard
fun optFormat(raw: String)
Link copied to clipboard
Link copied to clipboard
fun optOutputDir(path: String)
Link copied to clipboard
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open fun property(propertyName: String?): Any?
Link copied to clipboard
open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)
Link copied to clipboard
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<*>?)
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)
Link copied to clipboard
open fun setOnlyIf(onlyIfClosure: Closure<*>?)
open fun setOnlyIf(spec: Spec<in Task?>?)
open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)
Link copied to clipboard
open fun setProperty(name: String?, value: Any?)
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)
Link copied to clipboard
open fun shouldRunAfter(vararg paths: Any?): TaskDependency?
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<*>?>?)