aalekh-gradle/com.aalekh.aalekh.gradle.task/AalekhDocsTask

AalekhDocsTask

@CacheableTask

abstract class AalekhDocsTask : DefaultTask(source)

Writes the project's architecture documentation as Markdown.

The HTML report is for exploring; these files are for reading and reviewing. They render on GitHub with no build step, so a reviewer sees them without cloning, and they diff line by line, so an architectural change appears in a pull request next to the code that caused it.

Run: ./gradlew aalekhDocs Output: <projectRoot>/build/reports/aalekh/docs/

The output is deterministic - no timestamps, no run ids, sorted throughout - which is what makes committing it worthwhile: re-running on an unchanged project rewrites the same bytes, so any diff is a real architectural change rather than noise from the tool having run again. Teams that want the documentation reviewed alongside the code copy the directory into the repository and add a CI step that fails when a re-run produces a diff.

Constructors

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer?

featureAllowedPairs

@get:Input

abstract val featureAllowedPairs: ListProperty<String>

@get:Input

abstract val featurePattern: Property<String>

open val finalizedBy: TaskDependency?

@get:Input

abstract val forbidEntries: ListProperty<String>

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NONE)

abstract val graphJsonFile: RegularFileProperty

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

@get:Input

abstract val layerEntries: ListProperty<String>

Serialized layers { } declarations; groups the regions document by the declared architecture.

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

@get:OutputDirectory

abstract val outputDir: DirectoryProperty

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

@get:Input

abstract val projectName: Property<String>

reachabilityEntries

@get:Input

abstract val reachabilityEntries: ListProperty<String>

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

@get:Input

abstract val ruleEntries: ListProperty<String>

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

sourceSetEntries

@get:Input

abstract val sourceSetEntries: ListProperty<String>

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

@get:Input

abstract val teamEntries: Property<String>

Serialized teams { } map; supplies ownership in the module catalogue.

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun finalizedBy(vararg paths: Any?): Task?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

open fun usesService(service: Provider<out BuildService<*>?>?)