Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ before it can reach a release. (There was briefly a separate `sdk:plugin-api` mo
third-party plugin framework; it was removed before ever shipping — see Removed, below — so it never
joined this list.)

## Unreleased
## 1.3.0 — 2026-08-24

Captured requests could only ever be discarded by restarting the session, so a long debugging run
turned the Traffic list into a haystack ([#23](https://github.com/devconsole-android/DevConsole/issues/23)).
Both operator surfaces can now clear them.

**Version note, deliberately unresolved here:** `NetworkTransactionStore` gains an abstract
`clear()`. That interface is not documented as a host extension point and nothing outside this repo
is known to implement it, but under this file's own [policy](#versioning-and-stability-policy) a new
abstract member is source-breaking for anyone who does. It is in `sdk:network`, not `sdk:api`, so it
does not automatically read as a major. The number is left for the release decision rather than
assumed.
**Why a minor, not a major:** `NetworkTransactionStore` gains an abstract `clear()`, which is
source-breaking for anyone who implements that interface. It lives in `sdk:network`, not `sdk:api`,
and this file's [policy](#versioning-and-stability-policy) reserves a major for breaks to `sdk:api`,
so what sets the number here is the new API this release adds. The interface is not documented as a
host extension point and nothing outside this repo is known to implement it — but a custom store
does have to add one method to compile against 1.3.0.

### Added

Expand Down Expand Up @@ -63,6 +63,26 @@ assumed.
new route could not otherwise reach it. Left abstract rather than given a no-op default: a custom
store that silently declined to clear would fail invisibly, which is worse than failing to compile.

- **The protected-artifact verifier is now one task per protected variant**, named
`verify<Variant>DevConsoleProtectedArtifacts`. `verifyDevConsoleProtectedArtifacts` survives as an
aggregate that depends on all of them, so `check`, the sample apps' CI invocations, and any host
release script that names it keep working unchanged. A host that wants to verify one variant on its
own can now ask for that variant's task by name.

### Fixed

- **Building one flavor's release no longer builds every other flavor's release.** The verifier used
to be a single task holding *every* protected variant's runtime classpath and packaged APK/AAB as
its own task inputs, and it was wired onto each protected variant's `assemble`/`bundle`. On a
flavored project that meant `assembleProductionRelease` pulled
`verifyStagingReleaseDevConsolePackagedArtifact` into the graph, which in turn pulled
`dexBuilderStagingRelease`, `bundleStagingRelease` and the rest — so the build resolved and
downloaded every other flavor's dependencies, and produced artifacts nobody asked for. A host whose
flavors carry environment-specific SDK coordinates saw its production build reach for
internal-only artifacts and stall or fail when that repository was unreachable. Splitting the
verifier per variant keeps each variant's inputs to itself: building `productionRelease` now
touches `productionRelease` only, with no loss of enforcement.

## 1.2.4 — 2026-08-20

### Fixed
Expand Down
88 changes: 79 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ dependencyResolutionManagement {
```kotlin
plugins {
id("com.android.application")
id("io.github.devconsole-android") version "1.2.4"
id("io.github.devconsole-android") version "1.3.0"
}

dependencies {
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:1.2.4")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:1.2.4")
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:1.3.0")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:1.3.0")
}
```

Expand Down Expand Up @@ -376,8 +376,8 @@ Add the adapter — it is not part of the `devconsole` umbrella, so that Firebas
classpath of an app that doesn't use it:

```kotlin
debugImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase:1.2.4")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase-noop:1.2.4")
debugImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase:1.3.0")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase-noop:1.3.0")
```

> These two artifacts first ship in `1.2.0`; earlier versions do not have them.
Expand Down Expand Up @@ -452,8 +452,8 @@ You never name those. Every module publishes sources, javadoc, and a POM.
### Versions and unreleased code

All 34 library artifacts come from [JitPack](https://jitpack.io/#devconsole-android/DevConsole),
which builds a ref on demand. Releases are tagged `v1.2.4`, and JitPack resolves a bare version
against the `v`-prefixed tag, which is why the coordinates above read `1.2.4` — the same spelling
which builds a ref on demand. Releases are tagged `v1.3.0`, and JitPack resolves a bare version
against the `v`-prefixed tag, which is why the coordinates above read `1.3.0` — the same spelling
the Gradle plugin uses on the Portal. Any branch works as `<branch>-SNAPSHOT`, with `/` written as
`~`, so a `feature/x` branch is `feature~x-SNAPSHOT` — that is how you try an unreleased fix before
it ships. JitPack support starts at **1.1.1**; earlier tags do not build there. Two things to
Expand Down Expand Up @@ -488,11 +488,81 @@ Don't take the table's word for it. Check any build yourself:
aapt2 dump permissions app/build/outputs/apk/release/app-release.apk
```

The Gradle plugin enforces the same split mechanically. `verifyDevConsoleProtectedArtifacts` fails
the build if the full runtime reaches a protected variant, checking declared dependencies, the
The Gradle plugin enforces the same split mechanically. `verify<Variant>DevConsoleProtectedArtifacts`
fails the build if the full runtime reaches a protected variant, checking declared dependencies, the
resolved runtime classpath, and the final APK/AAB bytes. See
[Build variants and production safety](docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md).

## Flavored projects: verify the variant you ship

**If your app has product flavors, read this before wiring the plugin into a release pipeline.**

By default every non-debug variant is `PROTECTED`, so a project with `production`, `staging`, and
`partner` flavors gets three protected release variants and three verifiers:

```
verifyProductionReleaseDevConsoleProtectedArtifacts
verifyStagingReleaseDevConsoleProtectedArtifacts
verifyPartnerReleaseDevConsoleProtectedArtifacts
```

Each one is wired onto **its own** `assemble<Variant>` / `bundle<Variant>` and nothing else, so
`./gradlew :app:assembleProductionRelease` verifies `productionRelease` and resolves
`productionRelease`'s classpath — no other flavor is touched. That matters most when your flavors
carry environment-specific coordinates:

```groovy
productionImplementation "com.example.sdk:analytics-production-release:1.8.0"
stagingImplementation "com.example.sdk:analytics-staging-release:1.8.0"
partnerImplementation "com.example.sdk:analytics-partner-release:1.8.0"
```

A production build must never reach for another environment's artifacts — especially when those live
in a repository only reachable from an internal network. It doesn't.

The aggregate `verifyDevConsoleProtectedArtifacts` still exists and still verifies **every** protected
variant — that is its job, and `check` depends on it. On the project above it therefore resolves and
builds all three release variants. Use it in a CI job that is meant to cover everything; don't put it
on the critical path of a single-flavor release build:

```bash
./gradlew :app:assembleProductionRelease # ships production, verifies production
./gradlew :app:verifyProductionReleaseDevConsoleProtectedArtifacts # the same check on its own
./gradlew :app:verifyDevConsoleProtectedArtifacts # full sweep, all flavors, CI
```

### Upgrading from 1.2.4 or earlier

Up to and including 1.2.4 there was one shared verifier task carrying every protected variant's
inputs, wired onto every protected variant's `assemble`/`bundle`. Building one flavor's release
therefore built all of them. If you recognise any of these, that was the cause and this release fixes
it:

- a single-flavor release build downloading another flavor's dependencies
- `assembleProductionRelease` running `dexBuilderStagingRelease`, `bundlePartnerRelease`, or similar
- a release build failing or hanging on a repository only one flavor's artifacts live in
- release builds several times slower than the flavor being shipped could explain

No migration is needed — the task name your scripts and CI already call still works, it is now the
aggregate. If you worked around this by excluding the verifier (`-x verifyDevConsoleProtectedArtifacts`)
or by narrowing `protectedVariantPatterns` to one flavor, undo it: those workarounds bought speed by
dropping enforcement, and you no longer have to pay for one with the other.

### Narrowing what gets protected

If you genuinely want fewer protected variants — a flavor whose release build is never distributed,
say — lower the default and name what you protect. Understand that a variant left out is a variant
nobody checks:

```kotlin
devConsole {
defaultPolicy.set(DevConsoleVariantPolicy.DISABLED)
protectedVariantPatterns.set(listOf("(?i)production.*release"))
}
```

`DISABLED` variants still get `devconsole-noop` auto-wired — they simply are not verified.

## Security model

DevConsole deliberately exposes your app's internals to a browser, and two of its defaults trade
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class PublishingConventionPlugin : Plugin<Project> {
// The POM group. JitPack rewrites it to com.github.devconsole-android.DevConsole when it
// serves a build, so consumers name that group, not this one.
const val MAVEN_GROUP = "io.github.devconsole-android"
const val SDK_VERSION = "1.2.4"
const val SDK_VERSION = "1.3.0"
const val PROJECT_URL = "https://github.com/devconsole-android/DevConsole"
}
}
25 changes: 19 additions & 6 deletions docs/BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ devConsole {
protectedDependencyPaths.set(setOf(":sdk:full")) // default; override for a differently-pathed module
failBuildOnUnsafeVariant.set(true) // default; false downgrades to a warning
autoWireDependencies.set(true) // default; false to declare coordinates yourself
sdkVersion.set("1.2.4") // default; the JitPack version to resolve
sdkVersion.set("1.3.0") // default; the JitPack version to resolve
}
```

Expand Down Expand Up @@ -65,19 +65,32 @@ artifact, but only `PROTECTED` variants fail the build if the full runtime shows

## `devConsoleVariantReport` and `verifyDevConsoleProtectedArtifacts`

Two tasks come with the plugin:
The plugin registers:

- `devConsoleVariantReport` writes `build/reports/devconsole/variants.json` listing the effective
policy (`ENABLED`/`DISABLED`/`PROTECTED`) for every variant.
- `verifyDevConsoleProtectedArtifacts` inspects each protected variant's dependency graph for a
direct `ProjectDependency` on any path in `protectedDependencyPaths`, and fails the build if one
is found. Run it as part of your release checklist — the three sample apps run it in CI on every
push (see [`.github/workflows/verify.yml`](../.github/workflows/verify.yml)).
- `verify<Variant>DevConsoleProtectedArtifacts` — one task per protected variant — inspects that
variant's dependency graph for a direct `ProjectDependency` on any path in
`protectedDependencyPaths`, and fails the build if one is found. Each variant's
`assemble<Variant>` and `bundle<Variant>` depends on its own verifier, so building a protected
artifact always runs its checks.
- `verifyDevConsoleProtectedArtifacts` is the aggregate: it depends on every per-variant verifier,
and `check` hangs off it. Run it as part of your release checklist — the three sample apps run it
in CI on every push (see [`.github/workflows/verify.yml`](../.github/workflows/verify.yml)).

```bash
./gradlew :app:assembleRelease :app:verifyDevConsoleProtectedArtifacts
```

On a flavored project, ask for the variant you are actually shipping. The aggregate verifies *every*
protected variant, so on a project with `production`/`staging`/`partner` flavors it resolves — and
builds — all three release variants:

```bash
./gradlew :app:assembleProductionRelease # verifies productionRelease only
./gradlew :app:verifyProductionReleaseDevConsoleProtectedArtifacts # the same check, on its own
```

## Full/no-op parity

`devconsole` and `devconsole-noop` are compiled from the same shared facade source
Expand Down
11 changes: 11 additions & 0 deletions docs/FAQ_TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ dashboard assets, and storage layer live only in `sdk:full`, and `verifyDevConso
checks specifically for a dependency on that module, not for the absence of every DevConsole class.
See [BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md](BUILD_VARIANTS_AND_PRODUCTION_SAFETY.md).

**Why is my release build downloading another flavor's dependencies?** Up to 1.2.4 the plugin
registered a single `verifyDevConsoleProtectedArtifacts` task holding *every* protected variant's
runtime classpath and packaged artifact as its own inputs, and wired it onto each protected variant's
`assemble`/`bundle` — so `assembleProductionRelease` dragged `dexBuilderStagingRelease`,
`bundlePartnerRelease` and every other flavor's dependency download into the graph. Since then there
is one verifier per variant (`verifyProductionReleaseDevConsoleProtectedArtifacts`), each wired only
onto its own variant's tasks, and `verifyDevConsoleProtectedArtifacts` is an aggregate you invoke
deliberately.
Upgrade, and drop any `-x verifyDevConsoleProtectedArtifacts` workaround. See the flavored-projects
section in the [README](../README.md#flavored-projects-verify-the-variant-you-ship).

**I toggled a feature flag in the dashboard but my app didn't change.** Flags are pulled, not
pushed. Call `DevConsole.featureFlagValue(key)` wherever you'd otherwise check a local flag. There
is no change notification, so re-check after whatever user action would plausibly follow a QA
Expand Down
2 changes: 1 addition & 1 deletion docs/GETTING_STARTED_COMPOSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ devConsole {
}
```

`<version>` is a JitPack version — `1.2.4` for the current release. Releases are tagged `v1.2.4`,
`<version>` is a JitPack version — `1.3.0` for the current release. Releases are tagged `v1.3.0`,
and JitPack resolves a bare version against the `v`-prefixed tag, so the `v` is optional; the bare
form is used here because it also matches the plugin's version on the Gradle Plugin Portal.

Expand Down
2 changes: 1 addition & 1 deletion docs/GETTING_STARTED_XML_KOTLIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ devConsole {
}
```

`<version>` is a JitPack version — `1.2.4` for the current release. Releases are tagged `v1.2.4`,
`<version>` is a JitPack version — `1.3.0` for the current release. Releases are tagged `v1.3.0`,
and JitPack resolves a bare version against the `v`-prefixed tag, so the `v` is optional; the bare
form is used here because it also matches the plugin's version on the Gradle Plugin Portal.

Expand Down
4 changes: 2 additions & 2 deletions docs/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ dependencyResolutionManagement {
`v*` release tag:

```kotlin
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:1.2.4")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:1.2.4")
debugImplementation("com.github.devconsole-android.DevConsole:devconsole:1.3.0")
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-noop:1.3.0")
```

If you rely on the plugin's `autoWireDependencies` (the default), step 2 is done for you — you only
Expand Down
4 changes: 2 additions & 2 deletions docs/PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ dependencies {
```

`<version>` is a git ref. JitPack looks it up as a tag and falls back to the `v`-prefixed spelling
when no bare tag exists, so a release resolves either way — `1.2.4` and `v1.2.4` both serve the
`v1.2.4` build. Prefer the bare form: it is what the docs show, and it matches the version the
when no bare tag exists, so a release resolves either way — `1.3.0` and `v1.3.0` both serve the
`v1.3.0` build. Prefer the bare form: it is what the docs show, and it matches the version the
Gradle plugin carries on the Portal. Any branch works as `<branch>-SNAPSHOT`, with `/` written as
`~`, so a `feature/x` branch is `feature~x-SNAPSHOT`. JitPack support starts at **1.1.1**; earlier
tags do not build there, and bare `1.2.1` is a cached failed build — that one release resolves only
Expand Down
2 changes: 1 addition & 1 deletion docs/REMOTE_CONFIG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ debugImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-
releaseImplementation("com.github.devconsole-android.DevConsole:devconsole-remote-config-firebase-noop:<version>")
```

`<version>` is a JitPack version — `1.2.4` for the current release. Releases are tagged `v1.2.4`,
`<version>` is a JitPack version — `1.3.0` for the current release. Releases are tagged `v1.3.0`,
and JitPack resolves a bare version against the `v`-prefixed tag, so the `v` is optional; the bare
form is used here because it also matches the plugin's version on the Gradle Plugin Portal.

Expand Down
2 changes: 1 addition & 1 deletion gradle-plugin/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ plugins {
// Must share a top-level namespace with the plugin ID (a Plugin Portal requirement) and match
// the SDK's Maven group.
group = "io.github.devconsole-android"
version = "1.2.4"
version = "1.3.0"

// Targets Java 17: this plugin JAR runs inside the Gradle daemon (AGP 8.13.0
// requires JDK 17) and compiles against com.android.tools.build:gradle:8.13.0,
Expand Down
Loading
Loading