mirror of
https://github.com/jlengrand/detekt.git
synced 2026-03-10 08:11:23 +00:00
4e3d83abe1
* Prepare 1.10.0 release * Deactivate IsPropertyNaming rule for 1.10.0 release * Update self analysis and doc version
98 lines
3.4 KiB
Kotlin
Executable File
98 lines
3.4 KiB
Kotlin
Executable File
#!/bin/sh
|
|
//bin/true; exec kotlinc -script "$0" -- "$@"
|
|
|
|
/**
|
|
* Script to prepare release notes for the upcoming Detekt release
|
|
*
|
|
* You need kotlin 1.3.70+ installed on your machine
|
|
*/
|
|
|
|
@file:DependsOn("org.kohsuke:github-api:1.112")
|
|
@file:DependsOn("com.github.ajalt:clikt:2.7.1")
|
|
|
|
import com.github.ajalt.clikt.core.CliktCommand
|
|
import com.github.ajalt.clikt.parameters.options.default
|
|
import com.github.ajalt.clikt.parameters.options.option
|
|
import com.github.ajalt.clikt.parameters.types.int
|
|
import org.kohsuke.github.GHIssue
|
|
import org.kohsuke.github.GHIssueState
|
|
import org.kohsuke.github.GHMilestone
|
|
import org.kohsuke.github.GHRepository
|
|
import org.kohsuke.github.GitHub
|
|
import java.io.File
|
|
import java.net.URL
|
|
|
|
class GithubMilestoneReport : CliktCommand() {
|
|
|
|
private val user: String by option("-u", help = "Github user or organization. Default: detekt").default("detekt")
|
|
private val project: String by option("-p", help = "Github project. Default: detekt").default("detekt")
|
|
private val milestone: Int? by option("-m", help = "Milestone number. Default: latest milestone.").int()
|
|
|
|
override fun run() {
|
|
|
|
// connect to GitHub
|
|
val github: GitHub = GitHub.connectAnonymously()
|
|
val ghRepository: GHRepository = github.getUser(user).getRepository(project)
|
|
val milestones = ghRepository.listMilestones(GHIssueState.OPEN).toMutableList()
|
|
milestones.sortBy { it.number }
|
|
val milestoneId = milestone ?: milestones.last().number
|
|
|
|
// get milestone and issue data
|
|
|
|
val ghMilestone: GHMilestone = ghRepository.getMilestone(milestoneId)
|
|
val ghIssues: MutableList<GHIssue> = ghRepository.getIssues(GHIssueState.ALL, ghMilestone)
|
|
|
|
val milestoneTitle = ghMilestone.title.trim()
|
|
val groups = ghIssues.groupBy { issue ->
|
|
issue.labels.any { it.name == "housekeeping" }
|
|
}
|
|
val (issuesForUsers, issuesForDevs) = groups[false] to groups[true]
|
|
|
|
// print report
|
|
|
|
val content = StringBuilder().apply {
|
|
append(header(milestoneTitle))
|
|
append("\n")
|
|
append(section("Notable Changes"))
|
|
append("\n")
|
|
append(section("Migration"))
|
|
append("\n")
|
|
append(section("Changelog"))
|
|
append("\n")
|
|
append(formatIssues(issuesForUsers))
|
|
append("\n")
|
|
append(section("Housekeeping & Refactorings"))
|
|
append("\n")
|
|
append(formatIssues(issuesForDevs))
|
|
append("\n")
|
|
append(footer(milestoneTitle, ghMilestone.htmlUrl))
|
|
}.toString()
|
|
|
|
println(content)
|
|
|
|
// write report to disk
|
|
|
|
val tempFile: File = File.createTempFile(project, "_$milestoneId.$milestoneTitle")
|
|
tempFile.writeText(content)
|
|
|
|
println("\nContent saved to ${tempFile.path}")
|
|
}
|
|
|
|
// formatting helpers
|
|
|
|
private fun formatIssues(issues: List<GHIssue>?) =
|
|
issues?.joinToString(separator = "\n", postfix = "\n") { entry(it) } ?: ""
|
|
|
|
private fun entry(issue: GHIssue) = entry(issue.title.trim(), issue.number, issue.htmlUrl)
|
|
|
|
private fun entry(content: String, issueId: Int, issueUrl: URL) = "- $content - [#$issueId]($issueUrl)"
|
|
|
|
private fun footer(footer: String, url: URL) = "See all issues at: [$footer]($url)"
|
|
|
|
private fun header(name: String) = "#### $name\n"
|
|
|
|
private fun section(name: String) = "##### $name\n"
|
|
}
|
|
|
|
GithubMilestoneReport().main(args)
|