https://github.com/takanuva15/check-kdoc-present
[WIP] A GitHub Action to verify that Kotlin classes in your repository have documentation on them
https://github.com/takanuva15/check-kdoc-present
check documentation github-actions kdoc kotlin verify
Last synced: about 1 month ago
JSON representation
[WIP] A GitHub Action to verify that Kotlin classes in your repository have documentation on them
- Host: GitHub
- URL: https://github.com/takanuva15/check-kdoc-present
- Owner: takanuva15
- License: gpl-3.0
- Created: 2021-04-24T23:37:36.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-09T15:16:38.000Z (about 5 years ago)
- Last Synced: 2025-04-06T02:33:43.465Z (about 1 year ago)
- Topics: check, documentation, github-actions, kdoc, kotlin, verify
- Language: Kotlin
- Homepage:
- Size: 5.18 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**This action is under construction. I do not know a complete working kotlin parser that's publicly available, so this action will throw random errors for valid Kotlin files with documentation. Use at your own risk.**
# check-kdoc-present GitHub Action
A simple GitHub Action that runs a sanity check on your code to verify that every Kotlin file has at least one Kotlin documentation comment (kdoc) present. This helps keep your code documented and helps other developers looking at your code know what's going on.
## Getting Started
Assuming all your Kotlin source files are in the `~/src/main/kotlin` directory within the root of your repository, add the following to a new file `.github/workflows/verify_pr.yml`:
```yaml
name: Run PR Checks
on:
pull_request:
branches:
- main
jobs:
check_kdoc:
name: Verify KDoc Present on all Kotlin Classes
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Verify KDoc Present on all Kotlin Classes
uses: takanuva15/check-kdoc-present@main
```
Commit the file and create a PR to `main` - you should see the action run.
## Additional Usage Parameters
- `kotlin_dir`: The directory within your repository root that contains the Kotlin files you want to check
- Default is `src/main/kotlin`
Sample usage:
```yaml
steps:
- uses: actions/checkout@v2 #must checkout the repo for the action to have access to the Kotlin files
- name: Verify KDoc Present on all Kotlin Classes
uses: takanuva15/check-kdoc-present@main
with:
kotlin_dir: src/main/java
```
## Contributing
We are happy to take contributions. If you experience an issue or see something that can be improved, feel free to raise an issue. Assuming that there is agreement on the issue, fork the repo and raise a PR to make your change.
If you like this action, feel free to star/watch the repo to show your support!
## Credits
- Credit to [kotlinx/ast](https://github.com/kotlinx/ast) for providing the implementation of the kotlin parser.