Merge remote-tracking branch 'origin/main' into lint-updater

Author: jmfayard

.github/workflows/release-plugins.yml

@@ -20,6 +20,3 @@ jobs:
           wrapper-directory: plugins
           build-root-directory: plugins
           arguments: publishToAppropriateRepo --scan -Pgradle.publish.key=${{ secrets.gradle_publish_key }} -Pgradle.publish.secret=${{ secrets.gradle_publish_secret }}
-        env:
-          bintray_user: ${{ secrets.bintray_user }}
-          bintray_api_key: ${{ secrets.bintray_api_key }}

CHANGELOG.md

@@ -1,11 +1,12 @@
 # Change log for refreshVersions
 
-## Unreleased
+## Version 0.10.0 (2021-05-13)
 
 ### New features
 
+- There's a new `versionFor` function that takes a dependency notation, or a version key, and returns the corresponding version that is in the `versions.properties` file. For example, if you use Jetpack Compose, you can leverage it to set `kotlinCompilerExtensionVersion` with `versionFor(AndroidX.compose.ui)`. Groovy DSL users can find it in the `Versions` class.
 - Support updates of settings plugins in `settings.gradle.kts` and `settings.gradle` files (including refreshVersions itself).
-- Support getting versions from [Google Cloud Storage](https://cloud.google.com/storage) backed [repositories](https://docs.gradle.org/current/userguide/declaring_repositories.html#sec:gcs-repositories). This can be helpful if you need to update private artifacts hosted there. Thanks to [@NikkyAI](https://github.com/NikkyAI) for the contribution!
+- Support getting versions from [Google Cloud Storage](https://cloud.google.com/storage) backed [repositories](https://docs.gradle.org/current/userguide/declaring_repositories.html#sec:gcs-repositories). This can be helpful if you need to update private artifacts hosted there. Thanks to [NikkyAI](https://github.com/NikkyAI) for the contribution!
 
 ### Changes
 
@@ -16,22 +17,120 @@
 ### Potentially breaking changes
 
 - The fix of the `Square.sqlDelight.coroutinesExtensions` dependency notation can lead to such an error: `Failed to resolve: coroutines-extensions-1.4.4-_`. If you get a similar error on upgrade, it's because you applied a fix like that one: `Square.sqlDelight.coroutinesExtensions + ":_"`. You now can (must) remove it.
+- A bunch of new version key rules have been added, which means you might have changes of version keys, and because we currently don't have a migration facility for those, it might cause unwanted upgrades. Consequently, especially for Android projects, we recommend checking/verifying the changes made by refreshVersions after the first Gradle sync/reload/build that follows the upgrade.
 
 ### Fixes
 
-- Authentication for maven repositories should now work correctly. Should, because it can only work using internal Gradle APIs for the time being (though there's a safeguard to not crash if the API changes). Thanks to @mayankmkh for the PR!
+- Authentication for maven repositories should now work correctly. Should, because it can only work using internal Gradle APIs for the time being (though there's a safeguard to not crash if the API changes). Thanks to [Mayank Kharbanda](https://github.com/mayankmkh) for the PR!
+- Custom `extraArtifactVersionKeyRules` could not be taken into account if there was an overlapping rule already present in refreshVersions, even if it was more specific. That ordering issue has now been fixed, the most specific rule will now always be the one applied.
+- If you had issues with some recent AndroidX artifacts, and their version key, they should all be fixed now, and there's all the latest dependency notations.
 
 ### New dependency notations
 
+- AndroidX:
+    - activity.ktx
+    - activity.compose
+    - appSearch
+    - appSearch.compiler
+    - appSearch.localStorage
+    - biometricKtx
+    - carApp
+    - carApp.testing
+    - compose:
+        - material.ripple
+        - runtime.rxJava3
+        - runtime.saveable
+        - ui:
+            - test
+            - testJunit4
+            - testManifest
+            - tooling
+            - toolingData
+            - viewBinding
+    - constraintLayoutCompose
+    - core.googleShortcuts
+    - dataStore:
+        - core
+        - rxJava2
+        - rxJava3
+        - preferences:
+            - core
+            - rxJava2
+            - rxJava3
+    - hilt.navigationCompose
+    - hilt.navigationFragment
+    - leanback.paging
+    - leanback.preference
+    - leanback.tab
+    - lifecycle.viewModelCompose
+    - navigation.compose
+    - navigation.dynamicFeaturesFragment
+    - paging.compose
+    - paging.rxJava3
+    - savedStateKtx
+    - security.appAuthenticator
+    - transitionKtx
+    - wear:
+        - complications.data
+        - complications.provider
+        - input
+        - inputTesting
+        - ongoing
+        - phoneInteractions
+        - remoteInteractions
+        - watchFace
+        - watchFace.guava
+        - watchFace.client
+        - watchFace.clientGuava
+        - watchFace.complicationsRendering
+        - watchFace.data
+        - watchFace.editor
+        - watchFace.editorGuava
+        - watchFace.style
+        - tiles:
+            - proto
+            - renderer
+    - work.multiprocess
+    - work.rxJava3
 - Firebase:
-  - analyticsKtx
-  - authenticationKtx
-  - cloudMessagingKtx
-  - crashlyticsKtx
-  - dynamicLinksKtx
-  - performanceMonitoringKtx
+    - analyticsKtx
+    - authenticationKtx
+    - cloudMessagingKtx
+    - crashlyticsKtx
+    - dynamicLinksKtx
+    - performanceMonitoringKtx
+- Google:
+    - accompanist:
+        - appcompatTheme
+        - coil
+        - flowlayout
+        - glide
+        - imageloadingCore
+        - insets
+        - pager.indicators
+        - pager
+        - swiperefresh
+        - systemuicontroller
+    - android.material.composeThemeAdapter
+    - dagger.hilt.compiler
 - Testing.kotest.assertions.kotlinxDateTime
 
+### Special mentions
+
+Thanks to all the folks that joined [Louis CAD](https://github.com/LouisCAD) in pair-programming sessions:
+
+- [![](https://github.com/waah42.png?size=18) Waqas Ahmed](https://github.com/waah42)
+- [![](https://github.com/borsini.png?size=18) Benjamin Orsini](https://github.com/borsini)
+- [![](https://github.com/ZahraHeydari.png?size=18) Zahra Heydari](https://github.com/ZahraHeydari)
+- [![](https://github.com/ruffCode.png?size=18) Alexi Bre](https://github.com/ruffCode)
+- …and of course the original author and maintainer [![](https://github.com/jmfayard.png?size=18) Jean-Michel Fayard](https://github.com/jmfayard)
+
+These were critical to ensure thorough testing, and great quality, all while keeping motivation to keep going.
+
+We're very grateful for your time and help, and we think our users will be as well. 🙏
+
+Also, thanks to all the folks that reported issues. It was very helpful to prioritize on our side.
+
 ## Version 0.9.7 (2020-10-16)
 
 ### Fixes

README.md

@@ -1,5 +1,7 @@
 # gradle refreshVersions
 
-Life is too short to google for dependencies and versions.
+> Life is too short to google for dependencies and versions
 
 ### Documentation is at [jmfayard.github.io/refreshVersions](https://jmfayard.github.io/refreshVersions/)
+
+[![](https://raw.githubusercontent.com/jmfayard/refreshVersions/main/docs/img/screencast.png)](http://www.youtube.com/watch?v=VhYERonB8co "Gradle refreshVersions")

Releasing.main.kts

@@ -4,24 +4,18 @@
  * Copyright 2019 Louis Cognault Ayeva Derman. Use of this source code is governed by the Apache 2.0 license.
  */
 
-@file:Repository("https://dl.bintray.com/louiscad/maven")
+@file:Repository("https://repo.maven.apache.org/maven2/")
+//@file:Repository("https://oss.sonatype.org/content/repositories/snapshots")
 //@file:Repository("file:///Users/louiscad/.m2/repository")
-@file:DependsOn("com.louiscad.incubator:lib-publishing-helpers:0.1.3")
+@file:DependsOn("com.louiscad.incubator:lib-publishing-helpers:0.1.4")
 
 import java.io.File
 import Releasing_main.ReleaseStep.*
 
 import lib_publisher_tools.cli.CliUi
 import lib_publisher_tools.cli.defaultImpl
 import lib_publisher_tools.cli.runUntilSuccessWithErrorPrintingOrCancel
-import lib_publisher_tools.vcs.Vcs
-import lib_publisher_tools.vcs.checkoutDevelop
-import lib_publisher_tools.vcs.checkoutMaster
-import lib_publisher_tools.vcs.git
-import lib_publisher_tools.vcs.isOnDevelopBranch
-import lib_publisher_tools.vcs.mergeMasterIntoCurrent
-import lib_publisher_tools.vcs.pullFromOrigin
-import lib_publisher_tools.vcs.pushToOrigin
+import lib_publisher_tools.vcs.*
 import lib_publisher_tools.versioning.StabilityLevel
 import lib_publisher_tools.versioning.Version
 import lib_publisher_tools.versioning.checkIsValidVersionString
@@ -36,8 +30,8 @@ fun File.checkChanged() = check(git.didFileChange(this)) {
     "Expected changes in the following file: $this"
 }
 
-fun checkOnDevelopBranch() {
-    check(git.isOnDevelopBranch()) { "Please, checkout the `develop` branch first." }
+fun checkOnMainBranch() {
+    check(git.isOnMainBranch()) { "Please, checkout the `main` branch first." }
 }
 
 @Suppress("EnumEntryName")
@@ -52,8 +46,8 @@ enum class ReleaseStep { // Order of the steps, must be kept right.
     `Push tags to origin`,
     `Request PR merge`,
     `Request GitHub release publication`,
-    `Update master branch`,
-    `Update develop branch from master`,
+    `Update release branch`,
+    `Update main branch from release`,
     `Change this library version back to a SNAPSHOT`,
     `Commit "prepare next dev version"`,
     `Push, at last`;
@@ -87,7 +81,7 @@ if (ongoingReleaseFile.exists()) {
     OngoingRelease.load()
     startAtStep = ReleaseStep.valueOf(OngoingRelease.currentStepName)
 } else {
-    checkOnDevelopBranch()
+    checkOnMainBranch()
     with(OngoingRelease) {
         versionBeforeRelease = versionsFile.bufferedReader().use { it.readLine() }.also {
             check(it.contains("-dev-") || it.endsWith("-SNAPSHOT")) {
@@ -124,7 +118,7 @@ fun askNewVersionInput(
 
 fun CliUi.runReleaseStep(step: ReleaseStep): Unit = when (step) {
     `Change this library version` -> {
-        checkOnDevelopBranch()
+        checkOnMainBranch()
         OngoingRelease.newVersion.let { newVersion ->
             printInfo("refreshVersions new version: \"$newVersion\"")
             requestUserConfirmation("Confirm?")
@@ -176,7 +170,7 @@ fun CliUi.runReleaseStep(step: ReleaseStep): Unit = when (step) {
         git.pushToOrigin()
     }
     `Request PR submission` -> {
-        requestManualAction("Create a pull request from the `develop` to the `master` branch on GitHub for the new version, if not already done.")
+        requestManualAction("Create a pull request from the `main` to the `release` branch on GitHub for the new version, if not already done.")
     }
     `Wait for successful release by CI` -> {
         printInfo("To perform this step, we need to wait for the artifacts building and uploading.")
@@ -194,17 +188,17 @@ fun CliUi.runReleaseStep(step: ReleaseStep): Unit = when (step) {
     `Request GitHub release publication` -> {
         requestManualAction("Publish release on GitHub with the changelog.")
     }
-    `Update master branch` -> {
-        printInfo("Will now checkout the `master` branch, pull from GitHub (origin) to update the local `master` branch.")
+    `Update release branch` -> {
+        printInfo("Will now checkout the `release` branch, pull from GitHub (origin) to update the local `release` branch.")
         requestUserConfirmation("Continue?")
-        git.checkoutMaster()
+        git.checkoutBranch("release")
         git.pullFromOrigin()
     }
-    `Update develop branch from master` -> {
-        printInfo("About to checkout the develop branch (and update it from master for merge commits).")
+    `Update main branch from release` -> {
+        printInfo("About to checkout the main branch (and update it from release for merge commits).")
         requestUserConfirmation("Continue?")
-        git.checkoutDevelop()
-        git.mergeMasterIntoCurrent()
+        git.checkoutMain()
+        git.mergeBranchIntoCurrent("release")
     }
     `Change this library version back to a SNAPSHOT` -> {
         val newVersion = Version(OngoingRelease.newVersion)
@@ -219,18 +213,18 @@ fun CliUi.runReleaseStep(step: ReleaseStep): Unit = when (step) {
             printInfo("Congratulations for this new stable release!")
             printInfo("Let's update the library for next development version.")
             runUntilSuccessWithErrorPrintingOrCancel {
-                printInfo("Enter the name of the next target version (`-SNAPSHOT` will be added automatically)")
+                printInfo("Enter the name of the next target version (`-LOCAL-SNAPSHOT` will be added automatically)")
                 val input = readLine()
                 input.checkIsValidVersionString()
                 when (Version(input).stabilityLevel()) {
                     StabilityLevel.Unknown, StabilityLevel.Stable -> Unit
                     else -> error("You need to enter a stable target version")
                 }
-                "$input-SNAPSHOT"
+                "$input-LOCAL-SNAPSHOT"
             }
         } else OngoingRelease.versionBeforeRelease.let {
-            if (it.endsWith("-SNAPSHOT")) it
-            else "${it.substringBefore("-dev-")}-SNAPSHOT"
+            if (it.endsWith("-LOCAL-SNAPSHOT")) it
+            else "${it.substringBefore("-dev-")}-LOCAL-SNAPSHOT"
         }
         versionsFile.writeText(nextDevVersion)
         printInfo("${versionsFile.path} has been edited with next development version ($nextDevVersion).")

docs/add-dependencies.md

@@ -34,6 +34,7 @@ You can see [all the dependency objects in this directory]({{link.master}}/plugi
 All these dependency notations specify their version as the version
 placeholder (`_`), so refreshVersions can replace them seamlessly with the corresponding
 value defined in the `versions.properties` file, via Gradle APIs.
+The same will work for your own, non-built-in dependencies if you use that same version placeholder.
 
 After adding a dependency that doesn't have its version specified in the
 `versions.properties` file yet, refreshVersions will edit it and put the
@@ -80,16 +81,51 @@ plugins {
 
 As you see, the convention is pretty simple. The key is the id of the plugin, prefixed by `plugin.`: `plugin.some.plugin.id` sets the version of the plugin of id `some.plugin.id`.
 
+## Get the version from anywhere
+
+In some cases, you might need to get the version defined in the `versions.properties` file in a Gradle script.
+For these cases, there's the `versionFor` function that takes either a version key, or a full dependency notation.
+
+Here's a usage example with Jetpack Compose in an Android project:
+
+=== "build.gradle.kts"
+    ```kotlin
+    import de.fayard.refreshVersions.core.versionFor
+
+    ...
+
+    composeOptions {
+        kotlinCompilerExtensionVersion = versionFor(AndroidX.compose.ui)
+    }
+    ```
+=== "build.gradle"
+    ```groovy
+    import static de.fayard.refreshVersions.core.Versions.versionFor
+
+    ...
+
+    composeOptions {
+        kotlinCompilerExtensionVersion = versionFor(AndroidX.compose.ui)
+    }
+    ```
+
+Using `versionFor("version.androidx.compose.ui")` would also work, so long as `version.androidx.compose.ui` is defined in the `versions.properties` file.
+
 ## Non-built-in dependency notations
 
-### Use gradle buildSrcVersions (WIP)
+Generally speaking, so long as you have the version placeholder (`_`) in place of the version,
+refreshVersions will handle it.
+
+Below are some ways to deal with the dependency notations that are not built-in.
+
+### Using gradle buildSrcLibs (WIP)
 
 Yet another approach to managing dependencies is to use the **Gradle buildSrc** module, and to automatically generate a file `Libs.kt` that contains all the dependencies applied to your build:
 
 === "buildSrc/src/main/kotlin/Libs.kt"
 ```kotlin
 /**
- * Generated by `$ ./gradlew buildSrcVersions`
+ * Generated by `$ ./gradlew buildSrcLibs`
  */
 object Libs {
 
@@ -102,22 +138,23 @@ object Libs {
 
 Because this file used the placeholder version `_`, it is compatible with gradle refreshVersions!
 
-**This feature is not done yet. If you think we should prioritze it, please vote for [this issue]({{link.issues}}/235) with a 👍 and subscribe to it.**
+**This feature is not done yet. If you think we should prioritize it, please vote for [this issue]({{link.issues}}/235) with a 👍 and subscribe to it.**
 
 
-### Use Package Search from JetBrains
+### Using Package Search from JetBrains
 
-JetBrains offers the plugin [**Package Search**](https://plugins.jetbrains.com/plugin/12507-package-search).
+JetBrains offers the plugin [**Package Search**](https://plugins.jetbrains.com/plugin/12507-package-search),
+it is compatible with both IntelliJ IDEA and Android Studio. It also has a website
 
 Package Search provides a nice UX to add a dependency:
 
-![](https://d3nmt5vlzunoa1.cloudfront.net/idea/files/2019/10/Screenshot-2019-10-21-at-10.28.33-1.png)
+![](img/jetbrains_package_search_screenshot.png)
 
 Can you use it with refreshVersions?
 
 Sure, just use the version placeholder (`_`).
 
-### Use the libraries.gradle pattern
+### Using the libraries.gradle pattern
 
 An older approach to centralize dependencies is to have a `libraries.gradle` file:
 

docs/before-publish.sh

@@ -2,7 +2,8 @@
 
 ## Docs are powered by MKDocs
 
-The documentation of refreshVersions is published on a website accessible via this url: {{link.site}}.
+The documentation of refreshVersions is published on a website accessible via this url: [{{link.site}}](../index.md).
+
 It is generated with MKDocs from Markdown files.
 The variant of Markdown used in MKDocs has useful additional features that we use:
 - "Variables" interpolation, useful for long urls repeated in the doc.
@@ -13,7 +14,7 @@ The variant of Markdown used in MKDocs has useful additional features that we us
 A bunch of things are defined in the `mkdocs.yml` file (located at the root of the repo):
 
 - The structure of the documentation website is under the `nav` key.
-- Under the `extra` key, we have common text snippets (example usage: `{{ '{{' }}link.site{{ '}}' }}`)
+- Under the `extra` key, we have common text snippets (example usage: `{{ '{{' }}link.github{{ '}}' }}`)
 - Website metadata is defined at the top of the file (you probably don't need to touch it)
 - Theme and MKDocs configuration