Make it easy to publish to scans.gradle.com

- Allow init-script to publish to scans.gradle.com
- Add paramaters to enable build scan publishing
- Test coverage for build scan publishing

src/build-scan.ts

@@ -0,0 +1,33 @@
+import * as core from '@actions/core'
+import {
+    getBuildScanPublishEnabled,
+    getBuildScanTermsOfServiceUrl,
+    getBuildScanTermsOfServiceAgree
+} from './input-params'
+
+export function setup(): void {
+    if (getBuildScanPublishEnabled() && verifyTermsOfServiceAgreement()) {
+        maybeExportVariable('DEVELOCITY_INJECTION_ENABLED', 'true')
+        maybeExportVariable('DEVELOCITY_PLUGIN_VERSION', '3.16.1')
+        maybeExportVariable('DEVELOCITY_CCUD_PLUGIN_VERSION', '1.12.1')
+        maybeExportVariable('BUILD_SCAN_TERMS_OF_SERVICE_URL', getBuildScanTermsOfServiceUrl())
+        maybeExportVariable('BUILD_SCAN_TERMS_OF_SERVICE_AGREE', getBuildScanTermsOfServiceAgree())
+    }
+}
+
+function verifyTermsOfServiceAgreement(): boolean {
+    if (
+        getBuildScanTermsOfServiceUrl() !== 'https://gradle.com/terms-of-service' ||
+        getBuildScanTermsOfServiceAgree() !== 'yes'
+    ) {
+        core.warning(`Terms of service must be agreed in order to publish build scans.`)
+        return false
+    }
+    return true
+}
+
+function maybeExportVariable(variableName: string, value: unknown): void {
+    if (!process.env[variableName]) {
+        core.exportVariable(variableName, value)
+    }
+}

src/input-params.ts

@@ -75,6 +75,18 @@ export function getPRCommentOption(): JobSummaryOption {
     return parseJobSummaryOption('add-job-summary-as-pr-comment')
 }
 
+export function getBuildScanPublishEnabled(): boolean {
+    return getBooleanInput('build-scan-publish')
+}
+
+export function getBuildScanTermsOfServiceUrl(): string {
+    return core.getInput('build-scan-terms-of-service-url')
+}
+
+export function getBuildScanTermsOfServiceAgree(): string {
+    return core.getInput('build-scan-terms-of-service-agree')
+}
+
 function parseJobSummaryOption(paramName: string): JobSummaryOption {
     const val = core.getInput(paramName)
     switch (val.toLowerCase().trim()) {

src/resources/init-scripts/gradle-build-action.inject-develocity.init.gradle

@@ -82,6 +82,8 @@ def geEnforceUrl = Boolean.parseBoolean(getInputParam('develocity.enforce-url'))
 def buildScanUploadInBackground = Boolean.parseBoolean(getInputParam('develocity.build-scan.upload-in-background'))
 def gePluginVersion = getInputParam('develocity.plugin.version')
 def ccudPluginVersion = getInputParam('develocity.ccud-plugin.version')
+def buildScanTermsOfServiceUrl = getInputParam('build-scan.terms-of-service.url')
+def buildScanTermsOfServiceAgree = getInputParam('build-scan.terms-of-service.agree')
 
 def atLeastGradle4 = GradleVersion.current() >= GradleVersion.version('4.0')
 
@@ -103,10 +105,15 @@ if (GradleVersion.current() < GradleVersion.version('6.0')) {
                 }
                 if (!scanPluginComponent) {
                     logger.quiet("Applying $BUILD_SCAN_PLUGIN_CLASS via init script")
-                    logger.quiet("Connection to Develocity: $geUrl, allowUntrustedServer: $geAllowUntrustedServer")
                     applyPluginExternally(pluginManager, BUILD_SCAN_PLUGIN_CLASS)
-                    buildScan.server = geUrl
-                    buildScan.allowUntrustedServer = geAllowUntrustedServer
+                    if (geUrl) {
+                        logger.quiet("Connection to Develocity: $geUrl, allowUntrustedServer: $geAllowUntrustedServer")
+                        buildScan.server = geUrl
+                        buildScan.allowUntrustedServer = geAllowUntrustedServer
+                    } else if (buildScanTermsOfServiceUrl && buildScanTermsOfServiceAgree) {
+                        buildScan.termsOfServiceUrl = buildScanTermsOfServiceUrl
+                        buildScan.termsOfServiceAgree = buildScanTermsOfServiceAgree
+                    }
                     buildScan.publishAlways()
                     if (buildScan.metaClass.respondsTo(buildScan, 'setUploadInBackground', Boolean)) buildScan.uploadInBackground = buildScanUploadInBackground  // uploadInBackground not available for build-scan-plugin 1.16
                     buildScan.value CI_AUTO_INJECTION_CUSTOM_VALUE_NAME, CI_AUTO_INJECTION_CUSTOM_VALUE_VALUE
@@ -139,11 +146,16 @@ if (GradleVersion.current() < GradleVersion.version('6.0')) {
         if (gePluginVersion) {
             if (!settings.pluginManager.hasPlugin(DEVELOCITY_PLUGIN_ID)) {
                 logger.quiet("Applying $DEVELOCITY_PLUGIN_CLASS via init script")
-                logger.quiet("Connection to Develocity: $geUrl, allowUntrustedServer: $geAllowUntrustedServer")
                 applyPluginExternally(settings.pluginManager, DEVELOCITY_PLUGIN_CLASS)
                 extensionsWithPublicType(settings, DEVELOCITY_EXTENSION_CLASS).collect { settings[it.name] }.each { ext ->
-                    ext.server = geUrl
-                    ext.allowUntrustedServer = geAllowUntrustedServer
+                    if (geUrl) {
+                        logger.quiet("Connection to Develocity: $geUrl, allowUntrustedServer: $geAllowUntrustedServer")
+                        ext.server = geUrl
+                        ext.allowUntrustedServer = geAllowUntrustedServer
+                    } else if (buildScanTermsOfServiceUrl && buildScanTermsOfServiceAgree) {
+                        ext.buildScan.termsOfServiceUrl = buildScanTermsOfServiceUrl
+                        ext.buildScan.termsOfServiceAgree = buildScanTermsOfServiceAgree
+                    }
                     ext.buildScan.publishAlways()
                     ext.buildScan.uploadInBackground = buildScanUploadInBackground
                     ext.buildScan.value CI_AUTO_INJECTION_CUSTOM_VALUE_NAME, CI_AUTO_INJECTION_CUSTOM_VALUE_VALUE

src/setup-gradle.ts

@@ -7,6 +7,7 @@ import * as layout from './repository-layout'
 import * as params from './input-params'
 import * as dependencyGraph from './dependency-graph'
 import * as jobSummary from './job-summary'
+import * as buildScan from './build-scan'
 
 import {loadBuildResults} from './build-results'
 import {CacheListener} from './cache-reporting'
@@ -41,6 +42,8 @@ export async function setup(): Promise<void> {
     core.saveState(CACHE_LISTENER, cacheListener.stringify())
 
     await dependencyGraph.setup(params.getDependencyGraphOption())
+
+    buildScan.setup()
 }
 
 export async function complete(): Promise<void> {