Skip to content

Latest commit

 

History

History
108 lines (82 loc) · 3.83 KB

README.md

File metadata and controls

108 lines (82 loc) · 3.83 KB
Raw

Settings plugin

Add the following to settings.gradle or settings.gradle.kts to apply the plugin:

plugins {
    id("com.freeletics.gradle.settings").version("<latest-version>")
}

Features

Project discovery

The plugin will automatically discover all projects by finding their build files and include them. This means it is not necessary anymore to manually add include("...") for each project to settings.gradle.kts. The requirement for this to work is that the build file is named after the path. For example the project :foo:bar should have a build file called foo-bar.gradle.kts (or foo-bar.gradle). .gradle.kts discoverability is enabled by default and .gradle discoverability can be enabled with:

freeletics {
    discoverProjects(kts = false)
}

Mixing .gradle.kts and .gradle files for automatic discoverability is not supported.

Instead of using project root directory as a base for automatic discoverability it is possible to only include certain subdirectories by adding fgp.discoverProjects.automatically=false to project's gradle.properties and adding the following:

freeletics {
    it.discoverProjectsIn(
        directories = arrayOf("app", "features")
    )
}

dependencyResolutionManagement

The following repositories are automatically added to dependencyResolutionManagement:

  • Maven Central
  • the Google Maven Repository with exclusiveContent rules
  • the Gradle plugin portal limited to com.gradle.* and org.gradle.*
  • optionally the internal Freeletics repository if freeleticsAndroidArtifactsUrl is set
    • requires freeleticsAndroidArtifactsAccessKey and freeleticsAndroidArtifactsSecretKey properties to be set with valid S3 credentials

By default the project will also be configured to fail when repositories are defined on a project instead of through dependencyResolutionManagement. This can be disabled by setting fgp.kotlin.multiplatformProject=true if the repository has Kotlin Multiplatform projects because of this issue.

Snapshots

By adding the following snipped to settings.gradle it is possible to add various snapshot repositories to the project:

freeletics {
    snapshots()
    // or to include one of the AndroidX snapshot repositories from https://androidx.dev/snapshots/builds use
    snapshots("<build id>")
}

This adds:

  • both Sonatype snapshot repositories
  • the Jetpack Compose compiler snapshot repository
  • the Kotlin bootstrap repository which contains dev builds

Build cache

If the Gradle build cache is generally enabled the plugin allows configuring it through Gradle properties. By default the local build cache is enabled but can be disabled by setting fgp.buildcache.local=false.

The remote build cache can be enabled and configured like this:

fgp.buildcache.remote=true
fgp.buildcache.url=https://...
fgp.buildcache.push=true
fgp.buildcache.username=...
fgp.buildcache.password=...

Included builds

With the following snippet it is possible to configure an included build for Khonshu and FlowRedux Freeletics open source projects.

freeletics {
    includeKhonshu("path/to/cloned/khonshu/repository") // path can be omitted if it is ../khonshu
    includeFlowRedux("path/to/cloned/flowredux/repository") // path can be omitted if it is ../flowredux
}

Other