mirror of
https://github.com/gradle/gradle-build-action.git
synced 2024-10-18 19:51:18 +08:00
0a36ca9fb8
Cache entries _written_ from jobs run on a non-default branch will be private to other jobs for that branch. When development flow involves working on a feature branch and then merging into 'main', these branch-private cache entries can result in eviction of other (shared) cache entries generated for the default branch. With this change, we make the recommended setup the default, by running with `cache-read-only: true` for any jobs run on a non-default branch. These jobs will be able to read cache entries written from the main branch, but will not write any cache entries. Fixes #143
80 lines
2.8 KiB
YAML
80 lines
2.8 KiB
YAML
name: "Gradle Build Action"
|
|
description: 'Configures Gradle for use in GitHub actions, caching useful state in the GitHub actions cache'
|
|
|
|
# https://help.github.com/en/articles/metadata-syntax-for-github-actions
|
|
|
|
inputs:
|
|
gradle-version:
|
|
description: Gradle version to use
|
|
required: false
|
|
|
|
cache-disabled:
|
|
description: When 'true', all caching is disabled. No entries will be written to or read from the cache.
|
|
required: false
|
|
default: false
|
|
|
|
cache-read-only:
|
|
description: |
|
|
When 'true', existing entries will be read from the cache but no entries will be written.
|
|
By default this value is 'false' for workflows on the GitHub default branch and 'true' for workflows on other branches.
|
|
required: false
|
|
default: ${{ github.ref_name != github.event.repository.default_branch }}
|
|
# e.g. Use the following setting to only write cache entries from your 'main' branch
|
|
# cache-read-only: ${{ github.ref_name != 'main' }}
|
|
|
|
gradle-home-cache-includes:
|
|
description: Paths within Gradle User Home to cache.
|
|
required: false
|
|
default: |
|
|
caches
|
|
notifications
|
|
|
|
gradle-home-cache-excludes:
|
|
description: Paths within Gradle User Home to exclude from cache.
|
|
required: false
|
|
# e.g. Use the following setting to prevent the local build cache from being saved/restored
|
|
# gradle-home-cache-excludes: |
|
|
# caches/build-cache-1
|
|
|
|
arguments:
|
|
description: Gradle command line arguments (supports multi-line input)
|
|
required: false
|
|
|
|
build-root-directory:
|
|
description: Path to the root directory of the build
|
|
required: false
|
|
|
|
gradle-executable:
|
|
description: Path to the Gradle executable
|
|
required: false
|
|
|
|
# EXPERIMENTAL & INTERNAL ACTION INPUTS
|
|
# The following action properties allow fine-grained tweaking of the action caching behaviour.
|
|
# These properties are experimental and not (yet) designed for production use, and may change without notice in a subsequent release of `gradle-build-action`.
|
|
# Use at your own risk!
|
|
cache-write-only:
|
|
description: When 'true', entries will not be restored from the cache but will be saved at the end of the Job. This allows a 'clean' cache entry to be written.
|
|
required: false
|
|
default: false
|
|
gradle-home-cache-strict-match:
|
|
description: When 'true', the action will not attempt to restore the Gradle User Home entries from other Jobs.
|
|
required: false
|
|
default: false
|
|
workflow-job-context:
|
|
description: Used to uniquely identify the current job invocation. Defaults to the matrix values for this job; this should not be overridden by users (INTERNAL).
|
|
required: false
|
|
default: ${{ toJSON(matrix) }}
|
|
|
|
outputs:
|
|
build-scan-url:
|
|
description: Link to the build scan if any
|
|
|
|
runs:
|
|
using: 'node16'
|
|
main: 'dist/main/index.js'
|
|
post: 'dist/post/index.js'
|
|
|
|
branding:
|
|
icon: 'box'
|
|
color: 'gray-dark'
|