Documentation

Get a complete documentation site built with MkDocs, Dokka, and more.

Overview

• documentation
  • isEnabled: Property<Boolean> // false
  • enabled(value: Boolean = true)
  • changelog
  • readme
  • site

Changelog

Manage the changelog easily

Overview

• changelog
• isEnabled: Property<Boolean> // false
• enabled(value: Boolean = true)
• changelog(action: Action<ChangelogPluginExtension>)

Configuration

hubdle {
    config {
        documentation {
            changelog()
        }
    }
}

Patch the changelog

./gradlew patchChangelog

Add an item to the changelog

./gradlew addChangelogItem --added "some new addition"

./gradlew addChangelogItem --changed "some change"

./gradlew addChangelogItem --removed "something because it is no longer necessary"

Format the changelog

./gradlew applyFormatChangelog

Merge the changelog

Merge all non-final related versions into the final one

./gradlew mergeChangelog

Readme

Sync README with the current state of the project by running

./gradlew writeReadmeBadges

Overview

• readme
• isEnabled: Property<Boolean> // false
• enabled(value: Boolean = true)
• badges
  • isEnabled: Property<Boolean> // false
  • enabled(value: Boolean = true)
  • kotlin: Property<Boolean> // true
  • mavenCentral: Property<Boolean> // true
  • snapshots: Property<Boolean> // true
  • build: Property<Boolean> // true
  • coverage: Property<Boolean> // true
  • quality: Property<Boolean> // true
  • techDebt: Property<Boolean> // true

Configuration

Basic config

hubdle {
    config {
        documentation {
            readme {
                badges()
            }
        }
    }
}

Advanced config

hubdle {
    config {
        documentation {
            readme {
                badges {
                    isEnabled = true
                    kotlin = true
                    mavenCentral = true
                    snapshots = true
                    build = true
                    coverage = true
                    quality = true
                    techDebt = true   
                }
            }
        }
    }
}

Site

Build a site easily by running

./gradlew buildSite

Overview

• site
• isEnabled: Property<Boolean> // false
• enabled(value: Boolean = true)
• reports
  • isEnabled: Property<Boolean> // true
  • enabled(value: Boolean = true)
  • allTests: Property<Boolean> // true
  • codeAnalysis: Property<Boolean> // true
  • codeCoverage: Property<Boolean> // true
  • codeQuality: Property<Boolean> // true
• mkdocs(action: Action<MkdocsExtension>)

Configuration

Basic config

hubdle {
    config {
        documentation {
            site()
        }
    }
}

Advanced config

hubdle {
    config {
        documentation {
            site {
                isEnabled = true
                reports {
                    allTests = true
                    codeAnalysis = true
                    codeCoverage = true
                    codeQuality = true
                }
            }
        }
    }
}