docs: extract roadmap file

Signed-off-by: Artyom Shendrik <[email protected]>
fluxo-kt · Feb 26, 2024 · f997e5b · f997e5b
1 parent 4a121f2
commit f997e5b
Show file tree

Hide file tree

Showing 2 changed files with 213 additions and 203 deletions.
diff --git a/README.md b/README.md
@@ -138,209 +138,6 @@ pluginManagement {
 * [Avito android infrastructure](https://github.com/avito-tech/avito-android) ([docs](https://avito-tech.github.io/avito-android/))
 
 
-### Research roadmap
-<details>
-  <summary>Show</summary>
-
-* [Gradle Plugin TestKit](https://github.com/autonomousapps/dependency-analysis-gradle-plugin/tree/main/testkit) ([Docs](https://docs.gradle.org/current/userguide/test_kit.html))
-* https://github.com/square/radiography
-* https://github.com/JetBrains-Research/reflekt
-* https://github.com/mikepenz/AboutLibraries
-* https://github.com/gradle/gradle/issues/26091#issuecomment-1798137734
-* https://github.com/BenWoodworth/Parameterize
-* Set JDK release for kotlin compilation safety (`-Xjdk-release=`)
-* Detekt rules
-  * Enable more rules aside from baseline
-  * https://github.com/hbmartin/hbmartin-detekt-rules
-  * https://github.com/woltapp/arrow-detekt-rules
-  * https://detekt.dev/docs/rules/libraries/
-  * https://detekt.dev/docs/rules/ruleauthors
-  * https://github.com/topics/detekt-rules
-  * https://detekt.dev/marketplace
-    * https://detekt.dev/marketplace/#unpublished
-  * Create detekt rules for Gradle plugins best practices
-    * e.g., not to use `org.gradle.api.tasks.TaskCollection.matching`, `findByName`, etc. when `named` or `withType`
-     is enough (don't early create tasks).
-      * https://github.com/gmazzo/gradle-buildconfig-plugin/commit/a21a8b9
-    * e.g., a task must not use any Project objects at execution time.
-    * Also, warn on any `org.gradle.internal` usage because its is internal API.
-    * https://docs.gradle.org/8.5/userguide/configuration_cache.html#config_cache:requirements
-* Linting
-  * https://github.com/jeremymailen/kotlinter-gradle
-  * https://dev.to/aseemwangoo/supercharge-your-kotlin-project-2mcb
-  * Konsist
-    * https://github.com/LemonAppDev/konsist
-    * https://proandroiddev.com/protect-kotlin-project-architecture-using-konsist-3bfbe1ad0eea
-  * KDoc formatting
-    * https://github.com/tnorbye/kdoc-formatter
-* https://github.com/ashtanko/kotlin-app-template/tree/main
-  * Github Action + git-hook + Issues Template
-* __Infrastructure plugins__
-  * https://github.com/slackhq/slack-gradle-plugin/
-    * https://github.com/slackhq/slack-gradle-plugin/releases/tag/0.13.0
-    * https://github.com/slackhq/slack-gradle-plugin/releases/tag/0.14.0
-  * https://github.com/avito-tech/avito-android
-    * https://github.com/avito-tech/avito-android/blob/a1949b4/subprojects/assemble/proguard-guard/src/main/kotlin/com/avito/android/proguard_guard/shadowr8/ShadowR8TaskCreator.kt
-    * GIT hooks: https://github.com/avito-tech/avito-android/tree/develop/.git_hooks
-  * Gradle Core plugins
-    * https://github.com/gradle/gradle/tree/a300b86/platforms/documentation/docs/src/docs/userguide/core-plugins
-  * Gradle configuration
-    * https://github.com/Kotlin/kotlinx.coroutines/blob/d12eb45/kotlinx-coroutines-core/build.gradle#L238
-    * Test Suites
-      * https://docs.gradle.org/current/userguide/jvm_test_suite_plugin.html
-      * https://github.com/unbroken-dome/gradle-testsets-plugin
-    * Testing Gradle Builds
-      * Gradle TestKit: https://docs.gradle.org/current/userguide/test_kit.html
-        * TODO: `testSourceSets(sourceSets.functionalTest)`
-    * TWiStErRob's Quality plugin for Gradle that supports Android flavors
-      * https://github.com/TWiStErRob/net.twisterrob.gradle
-    * Nebula-plugins
-      * Healthy defaults for a standard Gradle project.
-        * https://github.com/nebula-plugins/nebula-project-plugin
-        * Builds Javadoc and Sources jars.
-        * Doesn't fail javadoc if there are none found.
-        * Record information about the build and stores it in the .jar, via [gradle-info-plugin](https://github.com/nebula-plugins/gradle-info-plugin).
-        * Easy specification of people involved in a project via [gradle-contacts-plugin](https://github.com/nebula-plugins/gradle-contacts-plugin).
-        * Introduces Nebula Dependency Lock Plugin out of the box, supports Gradle's Locking dependency versions mechanism too.
-        * Introduces Nebula Facet Plugin. A routine pattern is wanting a new SourceSet with an accompanying Configuration for dependencies.
-        * Introduces IntegTest Plugin specifically for Integration Tests.
-      * Nebula Dependency Lock Plugin
-        * https://github.com/nebula-plugins/gradle-dependency-lock-plugin
-        * Allows people using dynamic dependency versions to lock them to specific versions.
-        * Support saving and checking hash or signature of dependency in a report.
-          * Also note for safety against supply chain attacks:
-            https://github.com/dropbox/dependency-guard/issues/103
-      * Plugin to gather information about the environment
-        * https://github.com/nebula-plugins/gradle-info-plugin
-        * Noninvasively collect information about the environment, and make information available to other plugins in a statically typed way.
-        * When possible lazily calculate info.
-        * https://github.com/nebula-plugins/gradle-contacts-plugin
-          * Structure to define the owners of a project, then contributing this back to other plugins.
-      * Linter tool for identifying and reporting on patterns of misuse or deprecations in Gradle scripts.
-        * https://github.com/nebula-plugins/gradle-lint-plugin
-        * https://docs.gradle.org/current/userguide/authoring_maintainable_build_scripts.html
-      * Gradle plugin for providing reusable dependency resolution rules.
-        * https://github.com/nebula-plugins/gradle-resolution-rules-plugin
-      * Gradle capabilities and transforms to ease the migration from Java EE to Jakarta EE.
-        * https://github.com/nebula-plugins/gradle-jakartaee-migration-plugin
-      * Gradle plugin for constructing linux packages, specifically RPM and DEBs.
-        * https://github.com/nebula-plugins/gradle-ospackage-plugin
-      * Publishing related plugins
-        * https://github.com/nebula-plugins/nebula-publishing-plugin
-      * Test harness for Gradle plugins, leveraging [Spock](http://spockframework.org/).
-        * https://github.com/nebula-plugins/nebula-test
-      * Adds lot of NodeJS-based technologies as part of build without having Node.js installed locally.
-        * https://github.com/nebula-plugins/nebula-node-plugin
-      * Kotlin library providing extensions to assist with Gradle iterop and backwards compatibility.
-        * https://github.com/nebula-plugins/nebula-gradle-interop
-      * Gradle plugin introducing a provided dependency configuration and marking a dependency as optional.
-        * https://github.com/nebula-plugins/gradle-extra-configurations-plugin
-      * Base SCM Plugin for gathering information or performing actions (Archived).
-        * https://github.com/nebula-plugins/gradle-scm-plugin
-    * SgtSilvio gradle plugins
-      * Example: https://github.com/SgtSilvio/gradle-proguard/blob/61e7230/build.gradle.kts
-      * Gradle plugin to ease using and producing (multi-arch) OCI (Open Container Initiative, prev. Docker) images.
-        without requiring external tools.
-        * https://github.com/SgtSilvio/gradle-oci
-        * https://github.com/SgtSilvio/oci-registry (OCI registry Java library that allows serving OCI artifacts to pull operations).
-        * https://github.com/SgtSilvio/gradle-oci-junit-jupiter.
-      * Gradle plugin to ease defining project metadata (urls, license, scm).
-        * module name, readable name, url, docUrl, organization, license, developers, issue management, github.
-        * https://github.com/SgtSilvio/gradle-metadata
-      * Gradle plugin to ease defining Javadoc links.
-        * https://github.com/SgtSilvio/gradle-javadoc-links
-      * Gradle plugin that configures sensible defaults.
-        * https://github.com/SgtSilvio/gradle-defaults
-        * UTF 8 for Java compilation and Javadoc
-        * Reproducible artifacts
-        * Granular test reports per test case (method instead of class)
-* https://github.com/BenWoodworth/Parameterize
-* https://github.com/kotlin-hands-on/kotlin-swift-interopedia
-* https://github.com/drewhamilton/poko/
-  * https://github.com/saket/telephoto/releases/tag/0.7.1
-* https://telegra.ph/Compose-stabilityConfigurationPath-11-30
-  * https://fvilarino.medium.com/exploring-jetpack-compose-compilers-stability-config-f1ccb197d6c0
-* https://github.com/yandexmobile/detekt-rules-ui-tests
-  * https://habr.com/ru/companies/yandex/articles/779152/
-  * https://t.me/c/1198043993/3696
-  * https://edmundkirwan.com/general/cdd.html
-  * https://edmundkirwan.com/general/c-and-c.html
-* __https://github.com/VKCOM/vkompose/__
-  * https://mobiusconf.com/talks/0beebbbd16bf4358ab2a1b60cabf57a1
-  * https://t.me/compose_broadcast/202
-  * https://t.me/int_ax/47
-    * https://t.me/int_ax/47?comment=25
-    * https://t.me/int_ax/47?comment=29
-    * https://t.me/int_ax/47?comment=49
-* https://github.com/saveourtool/diktat
-* https://github.com/Kotlin/kotlinx-benchmark/
-  * https://github.com/CharlieTap/cachemap
-  * https://github.com/CharlieTap/cachemap/tree/failing-native-benchmark
-  * https://github.com/CharlieTap/cachemap/tree/benchmarking
-* https://gitlab.com/opensavvy/ci-templates
-  * https://gitlab.com/opensavvy/playgrounds/gradle/-/blob/main/.gitlab-ci.yml?ref_type=heads
-* https://github.com/gmazzo/gradle-codeowners-plugin
-* https://github.com/gmazzo/gradle-docker-compose-plugin
-* https://github.com/gmazzo/gradle-report-publications-plugin
-* !! https://github.com/gmazzo/gradle-android-manifest-lock-plugin
-* Shadowing + minification
-  * https://github.com/GradleUp/gr8 (Gr8 = Gradle + R8)
-  * Task used by the UI and Android tests to check minification results and keep track of binary size.
-    * https://github.com/lowasser/kotlinx.coroutines/blob/fcaa6df/buildSrc/src/main/kotlin/RunR8.kt
-  * A Gradle plugin that infers Proguard/R8 keep rules for androidTest sources.
-    * https://slackhq.github.io/keeper/
-      * https://github.com/slackhq/Keeper
-  * dProtect obfuscator
-    * https://github.com/open-obfuscator/dProtect
-  * Optimize app images
-    * https://tinypng.com/
-* Control licenses
-  * https://github.com/JetBrains/intellij-community/blob/8b5ce28/platform/build-scripts/src/org/jetbrains/intellij/build/CommunityLibraryLicenses.kt
-  * https://github.com/mikepenz/AboutLibraries
-* GitHub CI/CD, workflows and repo organization.
-  * Add automatic adding PR comment with Gradle Job Summary
-    * https://github.com/gradle/gradle-build-action/pull/1021/files
-    * https://github.com/gradle/gradle-build-action/issues/1020
-  * https://github.com/actions/dependency-review-action
-  * Compare artifacts in the commit (with prev commit) or PR (with upstream)
-    * https://github.com/JakeWharton/diffuse
-  * https://github.com/square/leakcanary/tree/main/.github
-  * MythicDrops repo organization. MegaLinter.io checks. [kodiakhq](https://github.com/apps/kodiakhq) bot.
-    * https://github.com/MythicDrops/mythicdrops-gradle-plugin/pull/108
-    * https://github.com/MythicDrops/mythicdrops-gradle-plugin?tab=readme-ov-file#maven-publish-plugin
-      * Configures published Maven POMs to include `compileOnly` dependencies as `provided`.
-      * Configures the project to sign published artifacts with GPG if `PGP_KEY` and `PGP_PWD` environment variables are available.
-    * https://github.com/MythicDrops/mythicdrops-gradle-plugin?tab=readme-ov-file#base-project-plugin
-      * Applies the [nebula.project](https://github.com/nebula-plugins/nebula-project-plugin) Gradle plugin.
-      * Applies the [com.adarshr.test-logger](https://github.com/radarsh/gradle-test-logger-plugin) Gradle plugin (with Mocha theme).
-      * Configures all test tasks to use JUnit Jupiter.
-      * Applies the [org.shipkit.shipkit-auto-version](https://github.com/shipkit/shipkit-auto-version) Gradle plugin.
-  * Karol Wrótniak tools
-    * https://github.com/koral--/gradle-pitest-plugin
-    * https://github.com/koral-- (note profile readme)
-  * Screenshot testing
-    https://github.com/pedrovgs/Shot
-* Stores publishing
-  * https://github.com/chippmann/androidpublisher/
-    * https://github.com/chippmann/androidpublisher/releases/tag/0.3.3
-* CI security scanning of Android app using AppSweep (API KEY REQUIRED)
-  * https://github.com/guardsquare/appsweep-gradle
-  * https://appsweep.guardsquare.com/
-  * https://plugins.gradle.org/plugin/com.guardsquare.appsweep
-* Java 9 modularity support
-  * https://github.com/Kotlin/kotlinx.coroutines/blob/d12eb45/buildSrc/src/main/kotlin/Java9Modularity.kt
-* Common utils
-  * https://github.com/aminography/CommonUtils/tree/1bfbe2d/library/src/main/java/com/aminography/commonutils
-* States and Events
-  * Circuit: https://slackhq.github.io/circuit/states-and-events/
-* Builds organization (multiple flavors, build types, build targets)
-  * https://github.com/ankidroid/Anki-Android/releases/tag/v2.17beta2
-* Validate & diff resulting artifacts
-  * https://github.com/JakeWharton/diffuse
-* Gradle task to report native libs from dependencies (dependency + names of the native binaries)
-</details>
-
-
 ### Versioning
 
 Uses [SemVer](http://semver.org/) for versioning.