In a project that reached maintenance phase there usually are multiple workarounds left to fix in the future.
This tools helps to find all links and check if they have been fixed already.
Supported issue trackers:
- ✅ Jetbrains Youtrack
- ✅ Github Issues
- ❌
Google IssueTracker
This repository contains a raw tool written kotlin, available on MavenCentral repository. Additionally, it exposes a fat Jar which serves as a CLI.
The core dependency is available under:
repositories.mavenCentral()
dependencies {
implementation("com.github.usefulness:issuechecker:x.y.z")
}
- CLI - A
jar
file available directly on Github Package Repository - download page - Gradle Plugin -
com.starter.quality
plugin runs the tool automatically underissueLinksReport
name - source - Github Action - ⏳ In progress ⏳
Usage: issue-checker-cli [OPTIONS]
Options:
-s, --src, --source TEXT Source file filter, i.e. `--source **.java` to
find all java files
--github-token TEXT Github token to check private issues
-d, --debug Enables additional logging
--stacktrace Shows additional stacktrace in case of failure
--dry-run Only finds all links, without checking them
-h, --help Show this message and exit
Sample commands:
- Find all links in files with
.kt
extension:
java -jar issue-checker-cli.jar --dry-run --source "**.kt"
- Find and check all links in files with
.java
extension:
java -jar issue-checker-cli.jar --source "**.java"