Skip to content

Commit eb261d5

Browse files
authored
Document plugin authentication in README
1 parent 875d136 commit eb261d5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

setup-gradle/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,9 @@ graph cannot be generated or submitted. You can enable this behavior with the `d
555555
### Using a custom plugin repository
556556

557557
By default, the action downloads the `github-dependency-graph-gradle-plugin` from the Gradle Plugin Portal (https://plugins.gradle.org). If your GitHub Actions environment does not have access to this URL, you can specify a custom plugin repository to use.
558+
558559
Do so by setting the `GRADLE_PLUGIN_REPOSITORY_URL` environment variable with your Gradle invocation.
560+
The `GRADLE_PLUGIN_REPOSITORY_USERNAME` and `GRADLE_PLUGIN_REPOSITORY_PASSWORD` can be used when the plugin repository requires authentication.
559561

560562
```yaml
561563
jobs:
@@ -571,6 +573,10 @@ jobs:
571573
run: ./gradlew build
572574
env:
573575
GRADLE_PLUGIN_REPOSITORY_URL: "https://gradle-plugins-proxy.mycorp.com"
576+
577+
# Set the following variables if your custom plugin repository requires authentication
578+
# GRADLE_PLUGIN_REPOSITORY_USERNAME: "username"
579+
# GRADLE_PLUGIN_REPOSITORY_PASSWORD: ${secrets.MY_REPOSITORY_PASSWORD}
574580
```
575581

576582
### Choosing which Gradle invocations will generate a dependency graph

0 commit comments

Comments
 (0)