docs: auto generate list of patches in README.md (#133)

* feat: auto generate list of patches in `README.md`

* sample readme

* formatting

* add codeblocks

* sample readme

* run on publish

* make workflow commit readme

* update readme [skip ci]

* update gen [skip ci]

* update workflow [skip ci]

* add readme to release assets

* fix: spacing in title

Co-authored-by: Sculas <contact@sculas.xyz>
Co-authored-by: oSumAtrIX <johan.melkonyan1@web.de>
This commit is contained in:
bogadana
2022-07-08 21:17:39 +02:00
committed by GitHub
parent b40ba5cbca
commit ac1b645ae3
4 changed files with 68 additions and 3 deletions

View File

@ -1,3 +1,5 @@
import org.apache.tools.ant.taskdefs.ExecTask
plugins {
kotlin("jvm") version "1.7.0"
}
@ -49,12 +51,19 @@ tasks {
}
}
}
register<JavaExec>("generateReadme") {
description = "Generate README.md"
dependsOn(build)
classpath = sourceSets["main"].runtimeClasspath
mainClass.set("app.revanced.patches.meta.ReadmeGenerator")
}
// Dummy task to fix the Gradle semantic-release plugin.
// Remove this if you forked it to support building only.
// Tracking issue: https://github.com/KengoTODA/gradle-semantic-release-plugin/issues/435
register<DefaultTask>("publish") {
group = "publish"
description = "Dummy task"
dependsOn(named("generateDex"))
dependsOn(named("generateDex"), named("generateReadme"))
}
}