🛠 ktlint GitHub reporter

A custom ktlint reporter that annotates Kotlin lint issues directly in GitHub PRs using official GitHub workflow commands.

• ✅ Integrates seamlessly with GitHub Actions
• 🎯 Supports error, warning, notice, or none levels
• 📦 Published to Maven Central

---

🚀 Quick Start

▶️ Using JAR

Download the latest JAR from the Releases page:

ktlint --reporter=github,artifact=ktlint-github-reporter.jar

Set the annotation level (default is error):

ktlint --reporter=github?level=warning,artifact=ktlint-github-reporter.jar

🛠 Using Maven or Gradle

Gradle (Kotlin or Groovy DSL)

repositories {
    mavenCentral()
}

dependencies {
    implementation "de.musichin.ktlint.reporter:ktlint-reporter-github:x.y.z"
}

Maven

<dependency>
  <groupId>de.musichin.ktlint.reporter</groupId>
  <artifactId>ktlint-reporter-github</artifactId>
  <version>x.y.z</version>
</dependency>

🧪 GitHub Actions Integration

Use in a GitHub Actions workflow:

steps:
  - uses: actions/checkout@v4
  - name: Run ktlint with GitHub reporter
    run: ktlint --reporter=github,artifact=ktlint-github-reporter.jar

Alternatively, use the ktlint-check GitHub Action:

- uses: musichin/ktlint-check@v4
  with:
    ktlint-version: '1.8.0'
    level: warning

This action internally uses this reporter.

🔧 Configuration Options

Option	Description	Default
level	Sets severity level: error, warning, notice, or none	error

Example

📝 License

MIT License © 2025 Anton Musichin