mirror of
https://github.com/golangci/golangci-lint-action.git
synced 2025-12-15 07:16:20 +00:00
feat: add option to control cache invalidation interval
This commit is contained in:
parent
ecb32920c6
commit
8c0f59df12
3 changed files with 35 additions and 2 deletions
17
README.md
17
README.md
|
|
@ -195,6 +195,23 @@ with:
|
|||
# ...
|
||||
```
|
||||
|
||||
### `cache-invalidation-interval`
|
||||
|
||||
(optional)
|
||||
|
||||
Periodically invalidate the cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
|
||||
|
||||
The default value is `7`.
|
||||
|
||||
```yml
|
||||
uses: golangci/golangci-lint-action@v5
|
||||
with:
|
||||
cache-invalidation-interval: 15
|
||||
# ...
|
||||
```
|
||||
|
||||
If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
|
||||
|
||||
### `annotations`
|
||||
|
||||
(optional)
|
||||
|
|
|
|||
|
|
@ -44,6 +44,10 @@ inputs:
|
|||
description: "golangci-lint command line arguments"
|
||||
default: ""
|
||||
required: false
|
||||
cache-invalidation-interval:
|
||||
description: "Periodically invalidate a cache because a new code being added. (number of days)"
|
||||
default: '7'
|
||||
required: false
|
||||
runs:
|
||||
using: "node20"
|
||||
main: "dist/run/index.js"
|
||||
|
|
|
|||
16
src/cache.ts
16
src/cache.ts
|
|
@ -25,6 +25,11 @@ const getLintCacheDir = (): string => {
|
|||
|
||||
const getIntervalKey = (invalidationIntervalDays: number): string => {
|
||||
const now = new Date()
|
||||
|
||||
if (invalidationIntervalDays <= 0) {
|
||||
return `${now.getTime()}`
|
||||
}
|
||||
|
||||
const secondsSinceEpoch = now.getTime() / 1000
|
||||
const intervalNumber = Math.floor(secondsSinceEpoch / (invalidationIntervalDays * 86400))
|
||||
return intervalNumber.toString()
|
||||
|
|
@ -32,21 +37,28 @@ const getIntervalKey = (invalidationIntervalDays: number): string => {
|
|||
|
||||
async function buildCacheKeys(): Promise<string[]> {
|
||||
const keys = []
|
||||
|
||||
const invalidationIntervalDays = parseInt(core.getInput(`cache-invalidation-interval`, { required: true }).trim())
|
||||
|
||||
// Periodically invalidate a cache because a new code being added.
|
||||
// TODO: configure it via inputs.
|
||||
let cacheKey = `golangci-lint.cache-${getIntervalKey(7)}-`
|
||||
let cacheKey = `golangci-lint.cache-${getIntervalKey(invalidationIntervalDays)}-`
|
||||
keys.push(cacheKey)
|
||||
|
||||
// Get working directory from input
|
||||
const workingDirectory = core.getInput(`working-directory`)
|
||||
|
||||
// create path to go.mod prepending the workingDirectory if it exists
|
||||
const goModPath = path.join(workingDirectory, `go.mod`)
|
||||
|
||||
core.info(`Checking for go.mod: ${goModPath}`)
|
||||
|
||||
if (await pathExists(goModPath)) {
|
||||
// Add checksum to key to invalidate a cache when dependencies change.
|
||||
cacheKey += await checksumFile(`sha1`, goModPath)
|
||||
} else {
|
||||
cacheKey += `nogomod`
|
||||
}
|
||||
|
||||
keys.push(cacheKey)
|
||||
|
||||
return keys
|
||||
|
|
|
|||
Loading…
Reference in a new issue