Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Splitties/refreshVersions
Life is too short to google for dependencies and versions
https://github.com/Splitties/refreshVersions
android gradle gradle-plugin hacktoberfest java kotlin scala versioning
Last synced: 3 months ago
JSON representation
Life is too short to google for dependencies and versions
- Host: GitHub
- URL: https://github.com/Splitties/refreshVersions
- Owner: Splitties
- License: mit
- Created: 2018-09-29T05:14:46.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T09:16:56.000Z (6 months ago)
- Last Synced: 2024-06-12T08:27:06.628Z (5 months ago)
- Topics: android, gradle, gradle-plugin, hacktoberfest, java, kotlin, scala, versioning
- Language: Kotlin
- Homepage: https://splitties.github.io/refreshVersions/
- Size: 11.9 MB
- Stars: 1,629
- Watchers: 11
- Forks: 107
- Open Issues: 116
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing/before-you-contribute.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-android - Gradle buildSrcVersions - A kotlin dsl to simplify dependencies management (Libraries / Other)
- awesome-list - Splitties/refreshVersions - Life is too short to google for dependencies and versions (Kotlin)
README
# What is refreshVersions?
**refreshVersions** helps **Gradle** users with the **tedious manual work** usually involved in adding and updating **dependencies and their versions**.
[](http://www.youtube.com/watch?v=VhYERonB8co "Gradle refreshVersions")
## Documentation
- [Start here](https://splitties.github.io/refreshVersions/)
- [Setup refreshVersions](https://splitties.github.io/refreshVersions/setup/)
- [Migrate your project](https://splitties.github.io/refreshVersions/migrate/)
- [Find Available Dependencies Updates](https://splitties.github.io/refreshVersions/update-dependencies/)
- [Add Dependencies](https://splitties.github.io/refreshVersions/add-dependencies/)
- [Explore built-in Dependencies Notations](https://splitties.github.io/refreshVersions/dependency-notations/)
- [Schedule the RefreshVersionsBot](https://splitties.github.io/refreshVersions/refreshversions-bot/)
- [Use the buildSrc](https://splitties.github.io/refreshVersions/gradle-buildsrcversions/)
- [Changelog](https://splitties.github.io/refreshVersions/CHANGELOG/)
[**See documentation at https://splitties.github.io/refreshVersions**](https://splitties.github.io/refreshVersions/)
## Setup
```kotlin
// settings.gradle(.kts)
plugins {
// See https://splitties.github.io/refreshVersions
id("de.fayard.refreshVersions") version "0.60.5"
}
refreshVersions { // Optional: configure the plugin
// ...
}
```
[Read the friendly documentation](https://splitties.github.io/refreshVersions/setup/)
## Usage
Make sure the project is correctly set up (see just above).
**Migrate project:**
The `refreshVersionsMigrate` task can help you migrate your project in a few minutes, or less.
In version 0.50.0, support for Gradle's Versions Catalogs was added ([see discussion thread here](https://github.com/Splitties/refreshVersions/discussions/592)), so a `--mode` option is now required.
Run it without it to see the complete list and the full description of each mode:
```shell
./gradlew refreshVersionsMigrate
```
Examples (click to expand)
If you want to use only `versions.properties` and the [built-in dependencies notations](https://splitties.github.io/refreshVersions/dependency-notations/), run:
`./gradlew refreshVersionsMigrate --mode=VersionsPropertiesOnly`
To also use a versions catalog for non-built-in dependency notations, run:
`./gradlew refreshVersionsMigrate --mode=VersionCatalogAndVersionProperties`
**Find available updates in `versions.properties` and the default versions catalog, if any:**
`./gradlew refreshVersions`
**Cleanup versions availability comments:**
`./gradlew refreshVersionsCleanup`