Skip to content

Commit

Permalink
Document plugin authentication in README
Browse files Browse the repository at this point in the history
  • Loading branch information
bigdaz committed Apr 4, 2024
1 parent 875d136 commit eb261d5
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions setup-gradle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,9 @@ graph cannot be generated or submitted. You can enable this behavior with the `d
### Using a custom plugin repository

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.

Do so by setting the `GRADLE_PLUGIN_REPOSITORY_URL` environment variable with your Gradle invocation.
The `GRADLE_PLUGIN_REPOSITORY_USERNAME` and `GRADLE_PLUGIN_REPOSITORY_PASSWORD` can be used when the plugin repository requires authentication.

```yaml
jobs:
Expand All @@ -571,6 +573,10 @@ jobs:
run: ./gradlew build
env:
GRADLE_PLUGIN_REPOSITORY_URL: "https://gradle-plugins-proxy.mycorp.com"

# Set the following variables if your custom plugin repository requires authentication
# GRADLE_PLUGIN_REPOSITORY_USERNAME: "username"
# GRADLE_PLUGIN_REPOSITORY_PASSWORD: ${secrets.MY_REPOSITORY_PASSWORD}
```

### Choosing which Gradle invocations will generate a dependency graph
Expand Down

0 comments on commit eb261d5

Please sign in to comment.