gradle/actions
1
0
Fork 0
mirror of https://github.com/gradle/actions.git synced 2025-04-22 02:39:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

adding doc and missing input

Browse Source
This commit is contained in:
Inaki Villar 2024-06-12 09:25:58 -07:00 committed by Daz DeBoer
parent 3301e37108
commit 3e750b614d
2 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/setup-gradle.md
View File

@ -726,6 +726,20 @@ Here's a minimal example:
This configuration will automatically apply `v3.17.5` of the [Develocity Gradle plugin](https://docs.gradle.com/develocity/gradle-plugin/), and publish build scans to https://develocity.your-server.com.
Alternatively, you can use the predefined input actions instead of specifying the environment parameters:
```yaml
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v3
with:
develocity-injection-enabled: true
develocity-url: https://develocity.your-server.com
develocity-plugin-version: 3.17.4
- name: Run a Gradle build with Develocity injection enabled from input actions
run: ./gradlew build
```
This example assumes that the `develocity.your-server.com` server allows anonymous publishing of build scans.
In the likely scenario that your Develocity server requires authentication, you will also need to pass a valid [Develocity access key](https://docs.gradle.com/develocity/gradle-plugin/#via_environment_variable) taken from a secret:
@ -769,6 +783,21 @@ The `init-script` supports several additional configuration parameters that you
| GRADLE_PLUGIN_REPOSITORY_USERNAME | | the username for the repository URL to use when resolving the Develocity and CCUD plugins |
| GRADLE_PLUGIN_REPOSITORY_PASSWORD | | the password for the repository URL to use when resolving the Develocity and CCUD plugins; Consider using secrets to pass the value to this variable |
All additional configuration parameters can be specified as input actions using:
| Variable | Input |
|--------------------------------------|--------------------------------------|
| DEVELOCITY_INJECTION_ENABLED | develocity-injection-enabled |
| DEVELOCITY_URL | develocity-url |
| DEVELOCITY_ALLOW_UNTRUSTED_SERVER | develocity-allow-untrusted-server |
| DEVELOCITY_CAPTURE_FILE_FINGERPRINTS | develocity-capture-file-fingerprints |
| DEVELOCITY_ENFORCE_URL | develocity-enforce-url |
| DEVELOCITY_PLUGIN_VERSION | develocity-plugin-version |
| DEVELOCITY_CCUD_PLUGIN_VERSION | develocity-ccud-plugin-version |
| GRADLE_PLUGIN_REPOSITORY_URL | gradle-plugin-repository-url |
| GRADLE_PLUGIN_REPOSITORY_USERNAME | gradle-plugin-repository-username |
| GRADLE_PLUGIN_REPOSITORY_PASSWORD | gradle-plugin-repository-password |
## Publishing to scans.gradle.com
Develocity injection is designed to enable the publishing of build scans to a Develocity instance,

4
setup-gradle/action.yml
View File

@ -120,6 +120,10 @@ inputs:
description: Allow communication with an untrusted server; set to _true_ if your Develocity instance is using a self-signed.
required: false
develocity-capture-file-fingerprints:
description: Enables capturing the paths and content hashes of each individual input file
required: false
develocity-enforce-url:
description: Enforce the configured Develocity URL over a URL configured in the project's build; set to _true_ to enforce publication of build scans to the configured Develocity URL.
required: false