api/dev.teogor.winds.api

Package-level declarations

Types

@Serializable

data class ArtifactDescriptor(var group: String, var name: String, var version: Version, var artifactIdFormat: ArtifactIdFormat = ArtifactIdFormat.FULL, var nameFormat: NameFormat = NameFormat.FULL)

ArtifactIdFormat

enum ArtifactIdFormat : Enum<ArtifactIdFormat>

BinaryCompatibility

data class BinaryCompatibility(var enabled: Boolean = false, var baselineVersion: String = "", var failOnIncompatibleChanges: Boolean = false)

BomOptions

data class BomOptions(var excludedScopes: List<String> = emptyList(), var acceptedModules: List<String> = emptyList(), var acceptedPaths: List<String> = emptyList())

CodebaseOptions

interface CodebaseOptions

CodeGen

interface CodeGen

Distribution

sealed interface Distribution

DocsGenerator

interface DocsGenerator : TaskBuilder

DocumentationBuilder

interface DocumentationBuilder

DokkaOptions

data class DokkaOptions(var enabled: Boolean = false, var outputDirectory: String = "", var sourceDirectories: List<String> = emptyList(), var additionalIncludes: List<String> = emptyList())

Features

interface Features

Represents features available for projects using the winds extension.

License

sealed interface License

ModuleMetadata

interface ModuleMetadata

NameFormat

enum NameFormat : Enum<NameFormat>

Person

sealed interface Person

Publishing

interface Publishing

PublishingOptions

interface ~~PublishingOptions~~

ReleaseStatus

enum ReleaseStatus : Enum<ReleaseStatus>

An enum class representing the different release statuses of a library.

Scm

sealed interface Scm

SonatypeHost

enum SonatypeHost : Enum<SonatypeHost>

Describes the various hosts for Sonatype OSSRH. Depending on when a user signed up with Sonatype they have to use different hosts.

SpotlessOptions

data class SpotlessOptions(var enabled: Boolean = false, var format: String = "", var includeFiles: List<String> = emptyList(), var excludeFiles: List<String> = emptyList())

TaskBuilder

interface TaskBuilder

TicketSystem

sealed interface TicketSystem

Represents the ticket system of a Maven publication.

Winds

interface Winds

WindsFeatures

interface ~~WindsFeatures~~

Represents features available for projects using the winds extension.

WorkflowSynthesizer

interface WorkflowSynthesizer : TaskBuilder