Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yutailang0119/action-ktlint
GitHub Action for ktlint
https://github.com/yutailang0119/action-ktlint
github-actions ktlint typescript
Last synced: 4 days ago
JSON representation
GitHub Action for ktlint
- Host: GitHub
- URL: https://github.com/yutailang0119/action-ktlint
- Owner: yutailang0119
- License: mit
- Created: 2020-04-14T15:03:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T11:53:04.000Z (15 days ago)
- Last Synced: 2024-10-26T10:46:02.276Z (13 days ago)
- Topics: github-actions, ktlint, typescript
- Language: TypeScript
- Homepage:
- Size: 2.08 MB
- Stars: 23
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - yutailang0119/action-ktlint - GitHub Action for ktlint (TypeScript)
README
# GitHub Action for ktlint
This Action generates annotations from [ktlint](https://ktlint.github.io) Report XML.
## Usage
An example workflow(.github/workflows/ktlint.yml) to executing ktlint follows:
```yml
name: ktlint
on:
pull_request:
paths:
- .github/workflows/ktlint.yml
- 'src/**/*.kt'
- '**.kts'
jobs:
ktlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: |
curl -sSLO https://github.com/pinterest/ktlint/releases/download/1.2.1/ktlint && chmod a+x ktlint && sudo mv ktlint /usr/local/bin/
- name: run ktlint
run: |
ktlint --reporter=checkstyle,output=build/ktlint-report.xml
continue-on-error: true
- uses: yutailang0119/action-ktlint@v4
with:
report-path: build/*.xml # Support glob patterns by https://www.npmjs.com/package/@actions/glob
ignore-warnings: true # Ignore Lint Warnings
continue-on-error: false # If annotations contain error of severity, action-ktlint exit 1.
```
## Author
[Yutaro Muta](https://github.com/yutailang0119)
## References
- Generated from [actions/typescript-action](https://github.com/actions/typescript-action) as template.
## License
action-ktlint is available under the MIT license. See [the LICENSE file](./LICENSE) for more info.