skippy/foundry.skippy/AffectedProjectsComputer

AffectedProjectsComputer

class AffectedProjectsComputer(rootDirPath: Path, dependencyMetadata: DependencyMetadata, changedFilePaths: List<Path>, diagnostics: DiagnosticWriter = DiagnosticWriter.NoOp, config: SkippyConfig = SkippyConfig(GLOBAL_TOOL, buildUponDefaults = true), androidTestProjects: Set<String> = emptySet(), debug: Boolean = false, fileSystem: FileSystem = FileSystem.SYSTEM, logger: FoundryLogger = FoundryLogger.noop())(source)

This is a program compute the set of Gradle projects that are affected by a set of changed files (changedFilePaths).

The intention of this program is to run as a preflight step in pull requests to only run a subset of checks affected by files changed in that PR. This allows CI on PRs to safely complete faster and reduce CI usage.

NOTE: Included builds are not supported.

Inputs

The primary input is changedFilePaths, which is a newline-delimited list of files that have changed. Usually the files changed in a pull request.

SkippyConfig.includePatterns is a list of glob patterns that are used to filter the list of changed files. These should usually be source files that are deemed to participate in builds (e.g. .kt files).

SkippyConfig.neverSkipPatterns is a list of glob patterns that, if matched with any changed file, indicate that nothing should be skipped and the full build should run. This is important for files like version catalog toml files or root build.gradle file changes.

Outputs

The primary output AffectedProjectsResult.affectedProjects is a set of Gradle project paths that are determined to be affected. This is intended to be used as an input to a subsequent Gradle invocation (usually as a file) to inform which projects can be avoided.

A secondary output file is AffectedProjectsResult.focusProjects. This is a set of Gradle project paths that can be written to a focus.settings.gradle file that can be used with the dropbox/focus plugin, and will be a minimal list of projects needed to build the affected projects.

With both outputs, if any "never-skippable" files SkippyConfig.neverSkipPatterns are changed, then no output file is produced and all projects are considered affected. If a file is produced but has no content written to it, that simply means that no projects are affected.

Debugging

To debug this task, pass in -Pslack.debug=true to enable debug logging. This will also output verbose diagnostics to diagnostics (usually build/skippy/diagnostics). Debug mode will also output timings.

Constructors

Link copied to clipboard
constructor(rootDirPath: Path, dependencyMetadata: DependencyMetadata, changedFilePaths: List<Path>, diagnostics: DiagnosticWriter = DiagnosticWriter.NoOp, config: SkippyConfig = SkippyConfig(GLOBAL_TOOL, buildUponDefaults = true), androidTestProjects: Set<String> = emptySet(), debug: Boolean = false, fileSystem: FileSystem = FileSystem.SYSTEM, logger: FoundryLogger = FoundryLogger.noop())

Functions

Link copied to clipboard