mirror of
https://github.com/gradle/actions.git
synced 2025-08-27 04:11:28 +08:00
e4f356955f
The Gradle build used to perform cache-cleanup will run in the context of init-scripts provided by the action, including those that collect build-results. In some circumstances this can lead to unexpected results, such as saving configuration-cache entries for cache cleanup executions. With this change, build results will not be captured for cache-cleanup builds.
87 lines
3.1 KiB
TypeScript
87 lines
3.1 KiB
TypeScript
import * as core from '@actions/core'
|
|
import * as exec from '@actions/exec'
|
|
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import * as provisioner from '../execution/provision'
|
|
|
|
export class CacheCleaner {
|
|
private readonly gradleUserHome: string
|
|
private readonly tmpDir: string
|
|
|
|
constructor(gradleUserHome: string, tmpDir: string) {
|
|
this.gradleUserHome = gradleUserHome
|
|
this.tmpDir = tmpDir
|
|
}
|
|
|
|
async prepare(): Promise<string> {
|
|
// Save the current timestamp
|
|
const timestamp = Date.now().toString()
|
|
core.saveState('clean-timestamp', timestamp)
|
|
return timestamp
|
|
}
|
|
|
|
async forceCleanup(): Promise<void> {
|
|
const cleanTimestamp = core.getState('clean-timestamp')
|
|
await this.forceCleanupFilesOlderThan(cleanTimestamp)
|
|
}
|
|
|
|
// Visible for testing
|
|
async forceCleanupFilesOlderThan(cleanTimestamp: string): Promise<void> {
|
|
// Run a dummy Gradle build to trigger cache cleanup
|
|
const cleanupProjectDir = path.resolve(this.tmpDir, 'dummy-cleanup-project')
|
|
fs.mkdirSync(cleanupProjectDir, {recursive: true})
|
|
fs.writeFileSync(
|
|
path.resolve(cleanupProjectDir, 'settings.gradle'),
|
|
'rootProject.name = "dummy-cleanup-project"'
|
|
)
|
|
fs.writeFileSync(
|
|
path.resolve(cleanupProjectDir, 'init.gradle'),
|
|
`
|
|
beforeSettings { settings ->
|
|
def cleanupTime = ${cleanTimestamp}
|
|
|
|
settings.caches {
|
|
cleanup = Cleanup.ALWAYS
|
|
|
|
releasedWrappers.setRemoveUnusedEntriesOlderThan(cleanupTime)
|
|
snapshotWrappers.setRemoveUnusedEntriesOlderThan(cleanupTime)
|
|
downloadedResources.setRemoveUnusedEntriesOlderThan(cleanupTime)
|
|
createdResources.setRemoveUnusedEntriesOlderThan(cleanupTime)
|
|
buildCache.setRemoveUnusedEntriesOlderThan(cleanupTime)
|
|
}
|
|
}
|
|
`
|
|
)
|
|
fs.writeFileSync(path.resolve(cleanupProjectDir, 'build.gradle'), 'task("noop") {}')
|
|
|
|
// TODO: This is ineffective: we should be using the newest version of Gradle that ran a build, or a newer version if it's available on PATH.
|
|
const executable = await provisioner.provisionGradleAtLeast('8.12')
|
|
|
|
await core.group('Executing Gradle to clean up caches', async () => {
|
|
core.info(`Cleaning up caches last used before ${cleanTimestamp}`)
|
|
await this.executeCleanupBuild(executable, cleanupProjectDir)
|
|
})
|
|
}
|
|
|
|
private async executeCleanupBuild(executable: string, cleanupProjectDir: string): Promise<void> {
|
|
const args = [
|
|
'-g',
|
|
this.gradleUserHome,
|
|
'-I',
|
|
'init.gradle',
|
|
'--info',
|
|
'--no-daemon',
|
|
'--no-scan',
|
|
'--build-cache',
|
|
'-DGITHUB_DEPENDENCY_GRAPH_ENABLED=false',
|
|
'-DGRADLE_ACTIONS_SKIP_BUILD_RESULT_CAPTURE=true',
|
|
'noop'
|
|
]
|
|
|
|
await exec.exec(executable, args, {
|
|
cwd: cleanupProjectDir
|
|
})
|
|
}
|
|
}
|