Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
15 changes: 9 additions & 6 deletions .github/instructions/gradle.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ All `src/*` Gradle projects share two repo config files: **`eng/gradle/plugin-re
pluginManagement {
apply from: "${rootDir}/../../eng/gradle/plugin-repositories.gradle", to: pluginManagement
}
plugins {
id 'com.microsoft.azure.artifacts.credprovider' version '1.1.1'
if (System.getenv('RUNNINGONCI') == 'true') {
apply from: "${rootDir}/../../eng/gradle/credential-provider.gradle"
}
dependencyResolutionManagement {
apply from: "${rootDir}/../../eng/gradle/dependency-repositories.gradle", to: dependencyResolutionManagement
Expand All @@ -25,12 +25,16 @@ rootProject.name = '<project>'

## CI vs local

Both files switch on `System.getenv('RunningOnCI')` (or `RUNNINGONCI` — AzDO uppercases env vars on Linux/macOS agents):
Both files switch on `System.getenv('RUNNINGONCI')`. Azure DevOps exports the
`RunningOnCI` pipeline variable under this normalized environment-variable name.

- **`RunningOnCI=true`** (Azure DevOps, set in `build-tools/automation/yaml-templates/variables.yaml`) → dnceng `dotnet-public-maven` feed (CFSClean isolation, https://aka.ms/1es/netiso/CFS). Anonymous read of cached packages.
- **`RUNNINGONCI=true`** (Azure DevOps, sourced from `RunningOnCI` in `build-tools/automation/yaml-templates/variables.yaml`) → dnceng `dotnet-public-maven` feed (CFSClean isolation, https://aka.ms/1es/netiso/CFS). Anonymous read of cached packages.
- **unset** (local, Dependabot, GitHub Actions) → `google()` + `mavenCentral()` + `gradlePluginPortal()` for plugins, `google()` + `mavenCentral()` for deps. No credentials needed.

Test the CI path locally: `$env:RunningOnCI='true'` (PowerShell) or `RunningOnCI=true ...` (bash).
The Azure Artifacts credential provider is also loaded only when
`RUNNINGONCI=true`, so local builds never attempt Azure authentication.

Test the CI path locally: `$env:RUNNINGONCI='true'` (PowerShell) or `RUNNINGONCI=true ...` (bash).

## When CI fails 401 on a Dependabot bump

Expand All @@ -54,5 +58,4 @@ After it succeeds, just re-run the failed CI job. No PR edits needed — the pac
## Don'ts

- Don't hard-code Maven repo URLs in `build.gradle` / `settings.gradle`; use the shared file.
- Don't wrap `plugins {}` in `if (...)` — Gradle rejects it.
- Don't use modern `plugins { id 'com.android.application' version '...' }` DSL without confirming the plugin is in `dotnet-public-maven`; prefer `buildscript { ... } / apply plugin: '...'` when in doubt.
15 changes: 15 additions & 0 deletions eng/gradle/credential-provider.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Azure DevOps uses this plugin to authenticate with the Maven mirror.
// This script is only applied when RUNNINGONCI=true.
buildscript {
repositories {
maven {
url = 'https://pkgs.dev.azure.com/artifacts-public/PublicTools/_packaging/AzureArtifacts/maven/v1'
name = 'AzureArtifacts'
}
}
dependencies {
classpath 'com.microsoft.azure:artifacts-gradle-credprovider:1.1.1'
}
}

apply plugin: com.microsoft.azure.artifacts.credprovider.gradle.GradleCredentialProviderPlugin

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested applying the plugin by ID from this applied script, but Gradle fails with Plugin with id ... not found. Plugins loaded through an applied script buildscript classpath are not registered for ID lookup, so this context requires the implementation class. I added a comment documenting that constraint. The script itself is now loaded only when ANDROID_MIRROR_MAVEN_DEPENDENCIES=true, which is set exclusively by the mirror helper.

10 changes: 2 additions & 8 deletions eng/gradle/dependency-repositories.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,10 @@
// (dependencyResolutionManagement.repositories) across every settings.gradle
// in this repo. See plugin-repositories.gradle for plugin resolution.
//
// Switches on RunningOnCI for the same CFSClean reasons described there.
// AzureArtifacts is intentionally NOT included here — it only hosts the
// credprovider plugin, so listing it in this scope would add a 404 round-trip
// to every dependency lookup.
// Switches on RUNNINGONCI for the same CFSClean reasons described there.

repositories {
// AzDO uppercases pipeline variables when exporting them as env vars on
// Linux/macOS agents, so check both spellings.
def runningOnCI = System.getenv('RunningOnCI') ?: System.getenv('RUNNINGONCI')
if (runningOnCI == 'true') {
if (System.getenv('RUNNINGONCI') == 'true') {
maven {
url = 'https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-maven/maven/v1'
name = 'dotnet-public-maven'
Expand Down
4 changes: 2 additions & 2 deletions eng/gradle/mirror-dependencies.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
so a developer has to authenticate locally once to seed the feed.

This script does that by running the requested gradle build in a loop:
1. Run gradle with RunningOnCI=true so it points at the dnceng feed.
1. Run gradle with RUNNINGONCI=true so it points at the dnceng feed.
2. Parse any 'Could not GET' URLs out of the build log.
3. Re-fetch each failing URL with an Azure DevOps OAuth bearer token
(obtained via `az account get-access-token`). The feed's upstream
Expand Down Expand Up @@ -113,7 +113,7 @@ if ($AndroidHome) { Write-Host "ANDROID_HOME: $AndroidHome" }
Get-AzDevOpsToken | Out-Null

if ($AndroidHome) { $env:ANDROID_HOME = $AndroidHome }
$env:RunningOnCI = 'true'
$env:RUNNINGONCI = 'true'

Push-Location $projectDirAbs
try {
Expand Down
17 changes: 2 additions & 15 deletions eng/gradle/plugin-repositories.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@
// across every settings.gradle in this repo. See plugin-repositories.gradle's
// sibling, dependency-repositories.gradle, for project dependency resolution.
//
// In our Azure DevOps CI pipeline (RunningOnCI=true), plugins resolve through
// In our Azure DevOps CI pipeline (RUNNINGONCI=true), plugins resolve through
// the dnceng Azure Artifacts feed (dotnet-public-maven) for CFSClean network
// isolation compliance (https://aka.ms/1es/netiso/CFS). Locally and from
// GitHub Actions (e.g. Dependabot), the standard Gradle Plugin Portal is used.
//
// AzureArtifacts (anonymous public feed) is always included because every
// settings.gradle loads the artifacts-credprovider plugin from there.
//
// The dnceng feed proxies public sources. Once any package has been pulled
// through the feed (an authenticated request), it is cached and anonymous
// reads work forever after. CI therefore does NOT need credentials — it just
Expand All @@ -22,17 +19,7 @@
// After it succeeds, just re-run the failed CI job — no PR edit is needed.

repositories {
// Anonymous public Azure Artifacts feed that hosts the
// artifacts-credprovider Gradle plugin (loaded by every settings.gradle).
maven {
url = 'https://pkgs.dev.azure.com/artifacts-public/PublicTools/_packaging/AzureArtifacts/maven/v1'
name = 'AzureArtifacts'
}

// AzDO uppercases pipeline variables when exporting them as env vars on
// Linux/macOS agents, so check both spellings.
def runningOnCI = System.getenv('RunningOnCI') ?: System.getenv('RUNNINGONCI')
if (runningOnCI == 'true') {
if (System.getenv('RUNNINGONCI') == 'true') {
maven {
url = 'https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-public-maven/maven/v1'
name = 'dotnet-public-maven'
Expand Down
4 changes: 2 additions & 2 deletions src/manifestmerger/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ pluginManagement {
apply from: "${rootDir}/../../eng/gradle/plugin-repositories.gradle", to: pluginManagement
}

plugins {
id 'com.microsoft.azure.artifacts.credprovider' version '1.1.1'
if (System.getenv('RUNNINGONCI') == 'true') {
apply from: "${rootDir}/../../eng/gradle/credential-provider.gradle"
}

dependencyResolutionManagement {
Expand Down
4 changes: 2 additions & 2 deletions src/proguard-android/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ pluginManagement {
apply from: "${rootDir}/../../eng/gradle/plugin-repositories.gradle", to: pluginManagement
}

plugins {
id 'com.microsoft.azure.artifacts.credprovider' version '1.1.1'
if (System.getenv('RUNNINGONCI') == 'true') {
apply from: "${rootDir}/../../eng/gradle/credential-provider.gradle"
}

dependencyResolutionManagement {
Expand Down
4 changes: 2 additions & 2 deletions src/r8/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ pluginManagement {
apply from: "${rootDir}/../../eng/gradle/plugin-repositories.gradle", to: pluginManagement
}

plugins {
id 'com.microsoft.azure.artifacts.credprovider' version '1.1.1'
if (System.getenv('RUNNINGONCI') == 'true') {
apply from: "${rootDir}/../../eng/gradle/credential-provider.gradle"
}

dependencyResolutionManagement {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ pluginManagement {
apply from: "${rootDir}/../../../../../eng/gradle/plugin-repositories.gradle", to: pluginManagement
}

plugins {
id 'com.microsoft.azure.artifacts.credprovider' version '1.1.1'
if (System.getenv('RUNNINGONCI') == 'true') {
apply from: "${rootDir}/../../../../../eng/gradle/credential-provider.gradle"
}

dependencyResolutionManagement {
Expand Down
Loading