mirror of
https://github.com/gradle/actions
synced 2024-11-27 20:02:19 +00:00
82 lines
4.2 KiB
YAML
82 lines
4.2 KiB
YAML
name: Gradle Dependency Submission
|
|
description: Generates a dependency graph for a Gradle project and submits it via the Dependency Submission API
|
|
|
|
inputs:
|
|
gradle-version:
|
|
description: |
|
|
Gradle version to use. If specified, this Gradle version will be downloaded, added to the PATH and used for invoking Gradle.
|
|
If not provided, it is assumed that the project uses the Gradle Wrapper.
|
|
required: false
|
|
build-root-directory:
|
|
description: Path to the root directory of the build. Default is the root of the GitHub workspace.
|
|
required: false
|
|
cache-encryption-key:
|
|
description: |
|
|
A base64 encoded AES key used to encrypt the configuration-cache data. The key is exported as 'GRADLE_ENCRYPTION_KEY' for later steps.
|
|
A suitable key can be generated with `openssl rand -base64 16`.
|
|
Configuration-cache data will not be saved/restored without an encryption key being provided.
|
|
required: false
|
|
dependency-graph:
|
|
description: |
|
|
Specifies how the dependency-graph should be handled by this action. By default a dependency-graph will be generated and submitted.
|
|
Valid values are:
|
|
'generate-and-submit' (default): Generates a dependency graph for the project and submits it in the same Job.
|
|
'generate-and-upload': Generates a dependency graph for the project and saves it as a workflow artifact.
|
|
'download-and-submit': Retrieves a previously saved dependency-graph and submits it to the repository.
|
|
|
|
The `generate-and-upload` and `download-and-submit` options are designed to be used in an untrusted workflow scenario,
|
|
where the workflow generating the dependency-graph cannot (or should not) be given the `contents: write` permissions
|
|
required to submit via the Dependency Submission API.
|
|
required: false
|
|
default: 'generate-and-submit'
|
|
additional-arguments:
|
|
description: |
|
|
Additional arguments to pass to Gradle. For example, `--no-configuration-cache --stacktrace`.
|
|
required: false
|
|
|
|
add-job-summary:
|
|
description: Specifies when a Job Summary should be inluded in the action results. Valid values are 'never', 'always' (default), and 'on-failure'.
|
|
required: false
|
|
default: 'always'
|
|
add-job-summary-as-pr-comment:
|
|
description: Specifies when each Job Summary should be added as a PR comment. Valid values are 'never' (default), 'always', and 'on-failure'. No action will be taken if the workflow was not triggered from a pull request.
|
|
required: false
|
|
default: 'never'
|
|
|
|
build-scan-publish:
|
|
description: |
|
|
Set to 'true' to automatically publish build results as a Build Scan on scans.gradle.com.
|
|
For publication to succeed without user input, you must also provide values for `build-scan-terms-of-use-url` and 'build-scan-terms-of-use-agree'.
|
|
required: false
|
|
default: false
|
|
build-scan-terms-of-use-url:
|
|
description: The URL to the Build Scan® terms of use. This input must be set to 'https://gradle.com/help/legal-terms-of-use'.
|
|
required: false
|
|
build-scan-terms-of-use-agree:
|
|
description: Indicate that you agree to the Build Scan® terms of use. This input value must be "yes".
|
|
required: false
|
|
|
|
# DEPRECATED ACTION INPUTS
|
|
build-scan-terms-of-service-url:
|
|
description: The URL to the Build Scan® terms of use. This input must be set to 'https://gradle.com/terms-of-service'.
|
|
required: false
|
|
deprecation-message: The input has been renamed to align with the Develocity API. Use 'build-scan-terms-of-use-url' instead.
|
|
|
|
build-scan-terms-of-service-agree:
|
|
description: Indicate that you agree to the Build Scan® terms of use. This input value must be "yes".
|
|
required: false
|
|
deprecation-message: The input has been renamed to align with the Develocity API. Use 'build-scan-terms-of-use-agree' instead.
|
|
|
|
# INTERNAL ACTION INPUTS
|
|
# These inputs should not be configured directly, and are only used to pass environmental information to the action
|
|
workflow-job-context:
|
|
required: false
|
|
default: ${{ toJSON(matrix) }}
|
|
github-token:
|
|
default: ${{ github.token }}
|
|
required: false
|
|
|
|
runs:
|
|
using: 'node20'
|
|
main: '../dist/dependency-submission/main/index.js'
|
|
post: '../dist/dependency-submission/post/index.js'
|