{"id":20135965,"url":"https://github.com/scacap/action-ktlint","last_synced_at":"2025-06-21T08:36:33.260Z","repository":{"id":37423758,"uuid":"237392106","full_name":"ScaCap/action-ktlint","owner":"ScaCap","description":"Run Ktlint with reviewdog","archived":false,"fork":false,"pushed_at":"2024-12-02T14:00:19.000Z","size":145,"stargazers_count":87,"open_issues_count":3,"forks_count":28,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-06-12T11:16:11.733Z","etag":null,"topics":["github-actions","kotlin","ktlint","reviewdog"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScaCap.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-31T08:49:05.000Z","updated_at":"2025-06-03T09:00:51.000Z","dependencies_parsed_at":"2023-12-19T21:32:05.592Z","dependency_job_id":"a1dd1721-ce35-4fe3-9263-a00eb34d3c88","html_url":"https://github.com/ScaCap/action-ktlint","commit_stats":{"total_commits":66,"total_committers":10,"mean_commits":6.6,"dds":0.5151515151515151,"last_synced_commit":"0169eb4232c76b235d26d94e92111c32aee7660e"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/ScaCap/action-ktlint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Faction-ktlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Faction-ktlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Faction-ktlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Faction-ktlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScaCap","download_url":"https://codeload.github.com/ScaCap/action-ktlint/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScaCap%2Faction-ktlint/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261094871,"owners_count":23108755,"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","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","kotlin","ktlint","reviewdog"],"created_at":"2024-11-13T21:17:10.836Z","updated_at":"2025-06-21T08:36:28.249Z","avatar_url":"https://github.com/ScaCap.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action: Run ktlint with reviewdog\n\nThis action runs [ktlint](https://ktlint.github.io/) with\n[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests\nto enforce best practices.\n\n## Examples\n\n### With `github-pr-check`\n\nBy default, with `reporter: github-pr-check` an annotation is added to\nthe line:\n![Example comment made by the action, with github-pr-check](./github-pr-check.png)\n\n### With `github-pr-review`\n\nWith `reporter: github-pr-review` a comment is added to\nthe Pull Request Conversation:\n![Example comment made by the action, with github-pr-review](./github-pr-review.png)\n\n## Inputs\n\n### `github_token`\n\n**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`.\n\n### `level`\n\nOptional. Report level for reviewdog [`info`,`warning`,`error`].\nIt's same as `-level` flag of reviewdog.\nThe default is `error`.\n\n### `reporter`\n\nOptional. Reporter of reviewdog command [`github-pr-check`,`github-pr-review`, `github-check`].\nThe default is `github-pr-check`.\n\nSee reviewdog reporters [documentation](https://github.com/reviewdog/reviewdog/tree/master#exit-codes) \nfor more details on their functionality.\n\n### `filter_mode`\n\nOptional. Filtering for the reviewdog command [`added`,`diff_context`,`file`,`nofilter`].\nThe default is `added`.\n\nSee reviewdog filter mode [documentation](https://github.com/reviewdog/reviewdog/tree/master#filter-mode) for more details.\n\n### `fail_on_error`\n\nOptional. Exit code for reviewdog when errors are found [`true`,`false`] \nDefault is false.\n\nSee reviewdog fail on error [documentation](https://github.com/reviewdog/reviewdog/tree/master#exit-codes) for more details.\n\n### `relative`\n\nOptional. Print files relative to the working directory [`true`/`false`]\nThe default value is true.\n\n### `android` (deprecated)\n\nOptional. Runs KtLint with [Android Kotlin Style Guide](https://android.github.io/kotlin-guides/style.html) [`true`/`false`]\nThe default value is false.\n\nNote: this field has no effect if `ktlint_version` is 1.0.1 or later. `code-style` command-line argument is deprecated in ktlint. Instead, `ktlint_code_style` property in `.editorconfig` \nneeds to be used. Example:\n```editorconfig\n[*.{kt,kts}]\nktlint_code_style = android_studio\n```\n\nMore in https://pinterest.github.io/ktlint/latest/rules/code-styles/\n\n### `baseline`\n\nOptional. Runs checks against the baseline file provided.\n\n### `ktlint_version`\n\nOptional. Defines the [ktlint](https://ktlint.github.io/) version to use.\nThe default value is `latest`.\n\n### `name`\n\nOptional. Reviewdog report name. See [checkstyle-format](https://github.com/reviewdog/reviewdog/tree/master#checkstyle-format) for details.\nThe default value is `ktlint`.\n\n### `file_glob`\n\nOptional. Defines a file glob to identify files to be checked.\nThe default value is an empty string.\n\n### `custom_rule_path`\n\nOptional. Provides path to JAR file with custom rules. The default value is an empty string.\n\n## Example usage\n\n```yml\nname: reviewdog\non: [pull_request]\njobs:\n  ktlint:\n    name: Check Code Quality\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Clone repo\n        uses: actions/checkout@master\n        with:\n          fetch-depth: 1\n      - name: ktlint\n        uses: ScaCap/action-ktlint@master\n        with:\n          github_token: ${{ secrets.github_token }}\n          reporter: github-pr-review # Change reporter\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscacap%2Faction-ktlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscacap%2Faction-ktlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscacap%2Faction-ktlint/lists"}