Retain pre-existing remote build cache config

[gabrielfeo]

Retain pre-existing remote cache configuration when setting the cache path, by never replacing an existing cache. Also support using the Develocity connector and warn in case the build has a custom cache type, for which the script cannot set the cache path.

Closes #507

[gabrielfeo]

Hi! This is a suggested fix for that issue. If you decide to accept this, I've only tested it briefly, because I saw in other PRs that you have many workflows that can test it better.

[erichaagdev]

Hi, @gabrielfeo. 👋

Thank you very much for your continued interest in improving the Develocity Build Validation Scripts.

What makes this more challenging is we must also continue to support the Gradle Enterprise plugin.

Prior to invoking the build, we call the Develocity API to query for several custom values in order to "recreate" the build as it was run in CI. This includes values like the repository, commit ID, branch, etc. You can see the full list here.

gradle-enterprise-build-validation-scripts/components/scripts/gradle/05-validate-remote-build-caching-ci-local.sh

Lines 162 to 180 in 17e8857

	read_build_params_from_build_scan_data() {
	if [ -z "${git_repo}" ]; then
	git_repo="${git_repos[0]}"
	project_name="$(basename -s .git "${git_repo}")"
	fi
	if [ -z "${git_branch}" ]; then
	git_branch="${git_branches[0]}"
	fi
	if [ -z "${git_commit_id}" ]; then
	git_commit_id="${git_commit_ids[0]}"
	fi
	if [ -z "${remote_build_cache_url}" ]; then
	remote_build_cache_url="${remote_build_cache_urls[0]}"
	fi
	if [ -z "${tasks}" ]; then
	tasks="${requested_tasks[0]}"
	remove_clean_from_tasks
	fi
	}

How I've always wanted to handle this is by updating the API call to return the configured remote build cache type. This is visible in a build scan and available in the Develocity API. The remote build cache can be configured accordingly from there. Unfortunately, the API client used by the scripts is closed source so this couldn't be implemented by an external contributor.

That being said, I will go ahead and leave this PR open to be discussed with the team.