Skip to content

Commit

Permalink
Document file-level ownership functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
simonschiller committed Mar 14, 2022
1 parent 16bd626 commit 1500fb2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Once this is done, `analyze<VariantName>Bundle` tasks will be added for each of

## Ownership

In larger organizations, Gradle modules and dependencies are often owned by specific teams. If that's the case for your app, Ruler can help you analyze app size contributions by different teams. All you need to do is provide a YAML file listing all components and their owners:
In larger organizations, Gradle modules and dependencies are often owned by specific teams. If that's the case for your app, Ruler can help you analyze app size contributions by different teams. All you need to do is provide a YAML file listing all components and their owners. It's also possible to specify ownership for individual files, if some of the files within a component are owned by a different team:

```yaml
# Identifier for Gradle modules -> path of the module
Expand All @@ -77,7 +77,11 @@ In larger organizations, Gradle modules and dependencies are often owned by spec
- identifier: androidx.core:core
owner: core-team

# Wildcard identifier -> matches multiple components (can be both modules or dependencies)
# Identifier for individual files -> Full path/name as it shows up in the APK
- identifier: com.sample.MainActivity
owner: main-team

# Wildcard identifier -> matches multiple components (modules or dependencies) or files
- identifier: :sample:wildcard:*
owner: wildcard-team
```
Expand Down
Binary file modified docs/ownership.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1500fb2

Please sign in to comment.