Skip to content

Commit

Permalink
Misc doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ZacSweers committed Oct 22, 2024
1 parent 998cf44 commit 069a7bf
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
12 changes: 6 additions & 6 deletions docs/platforms/gradle/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ Its responsibilities include:
- Running standard subproject configurations via `StandardProjectConfigurations`.
- Configuring unit tests via `UnitTests`. This also includes configuring the Gradle test retry plugin, if enabled.
- Configuring NullAway, if enabled.
- Configuring [Skippy](/tools/skippy).
- Configuring [Mod Score](../mod-score) tasks.
- Configuring [Skippy](../../tools/skippy.md).
- Configuring [Mod Score](mod-score.md) tasks.

### `StandardProjectConfigurations`

This class warrants special mention as it is responsible for the bulk of the configuration applied to projects SGP manages.

- Creates and exposes the [`foundry` extension DSL](../dsl).
- Creates and exposes the [`foundry` extension DSL](dsl.md).
- Applies common configurations.
- This largely just sets up the dependency sorter plugin.
- Applies common JVM configurations.
Expand All @@ -59,7 +59,7 @@ All JVM projects (Android, Java, Kotlin) receive some common configuration for t

- Applies the repo's platform project, if any.
- Applies any BOM dependencies to platform-configurable configurations.
- Configures the dependency analysis gradle plugin and [`DependencyRake`](../dependency-rake).
- Configures the dependency analysis gradle plugin and [`DependencyRake`](dependency-rake.md).
- Applies common annotations and common test bundles from version catalogs.
- Fails on non-androidx support library dependencies.
- Configure common annotations processors.
Expand All @@ -78,7 +78,7 @@ Java projects are fairly simple. Note that these are applied on all projects tha

##### Android

- Configures AndroidTest APK aggregation with [Skippy](/tools/skippy) support.
- Configures AndroidTest APK aggregation with [Skippy](../../tools/skippy.md) support.
- Applies the [Android cache fix plugin](https://github.com/gradle/android-cache-fix-gradle-plugin), if enabled.
- Configures common AGP extensions (both legacy extensions and new Component extensions).
- Disables unused/irrelevant variants. SGP is single-variant for library projects by default.
Expand All @@ -96,7 +96,7 @@ Java projects are fairly simple. Note that these are applied on all projects tha
- Application projects...
- have their packaging config set up with some convenience common exclusions and handling common `jniLibs` handling.
- have v3 and v4 signing enabled by default.
- are configured with [`PermissionChecks`](../utilities/#permissionchecks).
- are configured with [`PermissionChecks`](utilities.md#permissionchecks).
- are configured with the Bugsnag gradle plugin, if enabled.
- Library projects...
- are configured with an automatic `android.namespace`, if none is manually specified in the buildscript. The namespace is inferred from the project's Gradle path.
Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/gradle/dsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ behavior.

By default, SGP disables androidTests in projects. These can be enabled via the `androidTest()` feature, which will enable the relevant controls in the Android plugin. This can also accept specified variants to enable/disable.

This is important for opting in tests to [AndroidTest APK Aggregation](../utilities/#androidtest-apk-aggregation).
This is important for opting in tests to [AndroidTest APK Aggregation](utilities.md#androidtest-apk-aggregation).

### Resources

Expand All @@ -85,5 +85,5 @@ This can be enabled via the `resources()` feature, which will enable the relevan

### Permission AllowList

This enables checking of a permission allowlist. See [`PermissionChecks`](../utilities/#permissionchecks) for more
This enables checking of a permission allowlist. See [`PermissionChecks`](utilities.md#permissionchecks) for more
details.
4 changes: 2 additions & 2 deletions docs/platforms/gradle/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ tasks
```

This task is automatically added to whenever a subproject uses
the `androidTest()` [DSL feature](../dsl/#android-test).
the `androidTest()` [DSL feature](dsl.md#android-test).

## `PermissionChecks`

Expand All @@ -51,7 +51,7 @@ The workflow we use at Slack is like this:

- We check in a `permissionsAllowlist.txt` file in the Slack android repo.
- This file is owned in GitHub by a specific codeowner rule that adds a permission reviewers group.
- This file is passed into the `allowListFile` [DSL feature](../dsl/#permission-allowlist) in the application
- This file is passed into the `allowListFile` [DSL feature](dsl.md#permission-allowlist) in the application
project.
- On each build, SGP automatically checks that the permissions present in the release APK manifest match the ones
defined in the allowlist.
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ nav:
# - 'Thermals Logging': platforms/gradle/thermals-logging.md
- 'Tools':
- 'CLI': tools/cli.md
# TODO
# - 'Skippy': tools/skippy.md
- 'Discussions ⏏': https://github.com/slackhq/foundry/discussions
- 'Change Log': changelog.md
- 'API': api/0.x/
Expand Down

0 comments on commit 069a7bf

Please sign in to comment.