DEVELOPMENT.md

Development

Build

• Tool: Gradle
• Prerequisites
  • Windows, macOS, or Linux with JDK 11 or higher on PATH
• Config files
  • gradle/libs.version.toml
  • gradle/wrapper/gradle-wrapper.properties
  • gradle.properties
  • settings.gradle.kts
  • benchmark/build.gradle.kts
  • mxpack-core/build.gradle.kts
  • mxpack-kotlin/build.gradle.kts

Run full build

• ./gradlew build

Build libraries

• ./gradlew assemble
• Sources
  • mxpack-core/src/main/java/
  • mxpack-kotlin/src/main/kotlin/
• Outputs
  • mxpack-core/build/libs/
  • mxpack-kotlin/build/libs/

Format code

• ./gradlew spotApply

Run tests

• ./gradlew test
• Tools
  • JUnit 5
  • jqwik
• Sources
  • mxpack-core/src/test/java/
  • mxpack-kotlin/src/test/kotlin/
• Outputs
  • mxpack-core/build/reports/tests/test/index.html
  • mxpack-kotlin/build/reports/tests/test/index.html

Run benchmarks

• ./gradlew jmh (check which benchmarks are enabled in config file)
• Tool: JMH
• Config file: benchmark/build.gradle.kts section jmh {}
• Sources: benchmark/src/jmh/java

Generate API docs

• ./gradlew javadoc
• ./gradlew dokkaGen
• Tools
  • Javadoc
  • Dokka
• Outputs
  • mxpack-core/build/docs/javadoc/index.html
  • mxpack-kotlin/build/dokka/html/index.html

Website

• Tool: Material for MkDocs
  • pip install mkdocs-material
  • pip install mkdocs-linkcheck
• Prerequisites
  • Python
  • pip
• Config file: mkdocs.yml
• Sources: docs/

Preview website

• mkdocs serve

Validate links

• mkdocs-linkcheck

Continuous Integration

• Tool: GitHub Actions
• Config files: .github/workflows/

Delete all workflow runs

Requirements: PowerShell, gh

gh run list --limit 999 --json databaseId -q '.[].databaseId' |
ForEach-Object {
gh api "repos/$(gh repo view --json nameWithOwner -q .nameWithOwner)/actions/runs/$_" -X DELETE
}

Dependency Updates

• Tool: Renovate
• Config file: renovate.json