{"id":30307240,"url":"https://github.com/musichin/ktlint-github-reporter","last_synced_at":"2025-08-17T10:44:28.419Z","repository":{"id":38882649,"uuid":"404883477","full_name":"musichin/ktlint-github-reporter","owner":"musichin","description":"ktlint GitHub reporter","archived":false,"fork":false,"pushed_at":"2025-07-26T10:25:37.000Z","size":319,"stargazers_count":5,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-26T15:42:29.339Z","etag":null,"topics":["github-actions","github-commands","kotlin","ktlint"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/musichin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-09T22:11:53.000Z","updated_at":"2025-07-26T09:40:16.000Z","dependencies_parsed_at":"2024-02-15T22:30:06.938Z","dependency_job_id":"5d7ca8ad-9661-43c0-9a65-d213f2edaccc","html_url":"https://github.com/musichin/ktlint-github-reporter","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/musichin/ktlint-github-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/musichin%2Fktlint-github-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/musichin%2Fktlint-github-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/musichin%2Fktlint-github-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/musichin%2Fktlint-github-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/musichin","download_url":"https://codeload.github.com/musichin/ktlint-github-reporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/musichin%2Fktlint-github-reporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270837450,"owners_count":24654386,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","github-commands","kotlin","ktlint"],"created_at":"2025-08-17T10:44:27.529Z","updated_at":"2025-08-17T10:44:28.379Z","avatar_url":"https://github.com/musichin.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🛠 ktlint GitHub reporter\n[![Kotlin](https://img.shields.io/badge/Kotlin-2.2.0-blue.svg)](http://kotlinlang.org)\n[![CI](https://github.com/musichin/ktlint-github-reporter/actions/workflows/ci.yml/badge.svg)](https://github.com/musichin/ktlint-github-reporter/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/musichin/ktlint-github-reporter/branch/main/graph/badge.svg?token=I2LXI4OUBT)](https://codecov.io/gh/musichin/ktlint-github-reporter)\n[![Release](https://img.shields.io/github/v/release/musichin/ktlint-github-reporter)](https://github.com/musichin/ktlint-github-reporter/releases)\n[![Maven Central](https://img.shields.io/maven-central/v/de.musichin.ktlint.reporter/ktlint-reporter-github)](https://central.sonatype.com/artifact/de.musichin.ktlint.reporter/ktlint-reporter-github)\n\nA custom [ktlint](https://ktlint.github.io) reporter that annotates Kotlin lint issues directly in GitHub PRs using official GitHub [workflow commands](https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message).\n\n- ✅ Integrates seamlessly with GitHub Actions\n- 🎯 Supports `error`, `warning`, `notice`, or `none` levels\n- 📦 Published to Maven Central\n\n---\n\n## 🚀 Quick Start\n\n### ▶️ Using JAR\nDownload the latest JAR from the [Releases](https://github.com/musichin/ktlint-github-reporter/releases) page:\n\n```bash\nktlint --reporter=github,artifact=ktlint-github-reporter.jar\n```\nSet the annotation level (default is error):\n```bash\nktlint --reporter=github?level=warning,artifact=ktlint-github-reporter.jar\n```\n\n### 🛠 Using Maven or Gradle\n\n#### Gradle (Kotlin or Groovy DSL)\n```groovy\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    implementation \"de.musichin.ktlint.reporter:ktlint-reporter-github:x.y.z\"\n}\n```\n\n#### Maven\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ede.musichin.ktlint.reporter\u003c/groupId\u003e\n  \u003cartifactId\u003ektlint-reporter-github\u003c/artifactId\u003e\n  \u003cversion\u003ex.y.z\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### 🧪 GitHub Actions Integration\nUse in a GitHub Actions workflow:\n```yaml\nsteps:\n  - uses: actions/checkout@v4\n  - name: Run ktlint with GitHub reporter\n    run: ktlint --reporter=github,artifact=ktlint-github-reporter.jar\n```\nAlternatively, use the [ktlint-check](https://github.com/musichin/ktlint-check) GitHub Action:\n```yaml\n- uses: musichin/ktlint-check@v3\n  with:\n    ktlint-version: '1.7.0'\n    level: warning\n```\n\u003e This action internally uses this reporter.\n\n## 🔧 Configuration Options\n| Option  | Description                                                  | Default |\n|---------|--------------------------------------------------------------|---------|\n| `level` | Sets severity level: `error`, `warning`, `notice`, or `none` | `error` |\n\n## Example\n![](example.jpg)\n\n## 📝 License\nMIT License © 2025 Anton Musichin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmusichin%2Fktlint-github-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmusichin%2Fktlint-github-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmusichin%2Fktlint-github-reporter/lists"}