gradle-build-action/action.yml

name: "Gradle Build Action"
description: 'Executes a Gradle build, caching useful state in the GitHub actions cache'

# https://help.github.com/en/articles/metadata-syntax-for-github-actions

inputs:
  wrapper-directory:
    description: Path to the Gradle Wrapper directory
    required: false
    deprecationMessage: Use 'gradle-executable' to point to a gradlew[.bat] file in a non-default location
  gradle-executable:
    description: Path to the Gradle executable
    required: false
  gradle-version:
    description: Gradle version to use
    required: false
  build-root-directory:
    description: Path to the root directory of the build
    required: false
  arguments:
    description: Gradle command line arguments, see gradle --help
    required: false
  distributions-cache-enabled:
    description: Whether caching downloaded Gradle distributions is enabled or not, default to 'true'
    required: false
    default: true
  wrapper-cache-enabled:
    description: Whether caching wrapper installation is enabled or not, default to 'true'
    required: false
    default: true
    deprecationMessage: Replaced by 'distributions-cache-enabled' which enables caching for all downloaded Gradle distributions
  dependencies-cache-enabled:
    description: Whether caching dependencies is enabled or not, default to 'false'
    required: false
    default: false
  dependencies-cache-key:
    description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset
    required: false
  dependencies-cache-exact:
    description: Whether to restore only if exact match, default to 'false'
    required: false
    default: false
  configuration-cache-enabled:
    description: Whether caching build configuration is enabled or not, default to 'false'
    required: false
    default: false
  configuration-cache-key:
    description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset
    required: false
  configuration-cache-exact:
    description: Whether to restore only if exact match, default to 'false'
    required: false
    default: false
  cache-read-only:
    description: When 'true', existing entries will be read from the cache but no entries will be written
    required: false
    default: false

outputs:
  build-scan-url:
    description: Link to the build scan if any

runs:
  using: 'node12'
  main: 'dist/main/index.js'
  post: 'dist/post/index.js'
  post-if: success()

branding:
  icon: 'box'
  color: 'gray-dark'
Rename action from "Gradle Command" to "Gradle Build Action" 2021-08-17 15:31:28 +00:00			`name: "Gradle Build Action"`
Provide a better description for the action 2021-08-19 19:03:18 +00:00			`description: 'Executes a Gradle build, caching useful state in the GitHub actions cache'`
minor edits & build 2019-09-20 21:23:07 +00:00
Initial impl 2019-09-21 14:01:53 +00:00			`# https://help.github.com/en/articles/metadata-syntax-for-github-actions`
minor edits & build 2019-09-20 21:23:07 +00:00
Initial commit 2019-09-20 21:06:59 +00:00			`inputs:`
Initial impl 2019-09-21 14:01:53 +00:00			`wrapper-directory:`
			`description: Path to the Gradle Wrapper directory`
			`required: false`
Deprecate the 'wrapper-directory' input and recommend 'gradle-executable' instead Use of a wrapper in a non-standard directory is uncommon, and is effectively handled by referencing the `gradlew` script as the `gradle-executable`. 2021-07-07 18:45:24 +00:00			`deprecationMessage: Use 'gradle-executable' to point to a gradlew[.bat] file in a non-default location`
Initial impl 2019-09-21 14:01:53 +00:00			`gradle-executable:`
			`description: Path to the Gradle executable`
			`required: false`
			`gradle-version:`
			`description: Gradle version to use`
			`required: false`
			`build-root-directory:`
			`description: Path to the root directory of the build`
			`required: false`
			`arguments:`
minor edits & build 2019-09-20 21:23:07 +00:00			`description: Gradle command line arguments, see gradle --help`
			`required: false`
Cache Gradle distributions downloaded for a particular version (#58) - Cache is separate from (but similar to) the wrapper distribution cache - New 'distributions-cache-enabled' flag controls caching of all downloaded distributions (including wrapper distributions) - Deprecated the 'wrapper-cache-enabled' flag for removal in v2 2021-07-08 18:22:48 +00:00			`distributions-cache-enabled:`
			`description: Whether caching downloaded Gradle distributions is enabled or not, default to 'true'`
			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: true`
Add input to disable wrapper caching 2020-06-15 13:41:09 +00:00			`wrapper-cache-enabled:`
			`description: Whether caching wrapper installation is enabled or not, default to 'true'`
			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: true`
Cache Gradle distributions downloaded for a particular version (#58) - Cache is separate from (but similar to) the wrapper distribution cache - New 'distributions-cache-enabled' flag controls caching of all downloaded distributions (including wrapper distributions) - Deprecated the 'wrapper-cache-enabled' flag for removal in v2 2021-07-08 18:22:48 +00:00			`deprecationMessage: Replaced by 'distributions-cache-enabled' which enables caching for all downloaded Gradle distributions`
Add input to disable dependencies caching altogether 2020-06-15 12:30:25 +00:00			`dependencies-cache-enabled:`
Disable dependencies cache by default 2020-06-15 13:57:09 +00:00			`description: Whether caching dependencies is enabled or not, default to 'false'`
Add input to disable dependencies caching altogether 2020-06-15 12:30:25 +00:00			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: false`
Automatic caching of dependencies in a best effort manner by default allowing to specify files to hash for computing the cache key 2020-06-15 10:59:55 +00:00			`dependencies-cache-key:`
			`description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset`
			`required: false`
Add input to make the dependencies caching strict 2020-06-15 11:05:25 +00:00			`dependencies-cache-exact:`
Fix typo 2020-06-15 12:28:57 +00:00			`description: Whether to restore only if exact match, default to 'false'`
Add input to make the dependencies caching strict 2020-06-15 11:05:25 +00:00			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: false`
Add caching of Gradle build configuration cache 2020-06-15 13:58:20 +00:00			`configuration-cache-enabled:`
			`description: Whether caching build configuration is enabled or not, default to 'false'`
			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: false`
Add caching of Gradle build configuration cache 2020-06-15 13:58:20 +00:00			`configuration-cache-key:`
			`description: Globs of files to hash in the build root directory, separated by new lines, use best-effort if unset`
			`required: false`
			`configuration-cache-exact:`
			`description: Whether to restore only if exact match, default to 'false'`
			`required: false`
Use core functionality to access action inputs - Specify default values in action.yaml definition where appropriate - Replace custom methods with core functions: - getInputBoolean() with core.getBooleanInput() - inputOrNull() with core.getInput() - inputArrayOrNull() with core.getMultilineInput() - Remove github-utils.js 2021-07-20 17:44:56 +00:00			`default: false`
Allow use of caches 'read-only' To avoid evicting useful entries, some pipeline may benefit from using existing cache entries without writing any changes back to the cache. Fixes #62 2021-08-17 22:15:28 +00:00			`cache-read-only:`
			`description: When 'true', existing entries will be read from the cache but no entries will be written`
			`required: false`
			`default: false`
minor edits & build 2019-09-20 21:23:07 +00:00
Initial impl 2019-09-21 14:01:53 +00:00			`outputs:`
			`build-scan-url:`
			`description: Link to the build scan if any`

Initial commit 2019-09-20 21:06:59 +00:00			`runs:`
			`using: 'node12'`
Split action, step 1 2020-06-13 11:30:20 +00:00			`main: 'dist/main/index.js'`
Split action, step 2 2020-06-13 11:34:07 +00:00			`post: 'dist/post/index.js'`
			`post-if: success()`
Initial impl 2019-09-21 14:01:53 +00:00
			`branding:`
			`icon: 'box'`
			`color: 'gray-dark'`