Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gradle/common-custom-user-data-gradle-plugin
Gradle plugin that enhances published build scans by adding a set of tags, links and custom values that have proven to be useful for many projects building with Develocity.
https://github.com/gradle/common-custom-user-data-gradle-plugin
android gradle java
Last synced: about 21 hours ago
JSON representation
Gradle plugin that enhances published build scans by adding a set of tags, links and custom values that have proven to be useful for many projects building with Develocity.
- Host: GitHub
- URL: https://github.com/gradle/common-custom-user-data-gradle-plugin
- Owner: gradle
- License: apache-2.0
- Created: 2022-01-04T06:24:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T15:23:16.000Z (4 months ago)
- Last Synced: 2024-06-12T23:47:28.957Z (4 months ago)
- Topics: android, gradle, java
- Language: Java
- Homepage: https://gradle.com/develocity
- Size: 1.27 MB
- Stars: 41
- Watchers: 18
- Forks: 28
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> _This repository is maintained by the Develocity Solutions team, as one of several publicly available repositories:_
> - _[Develocity Build Configuration Samples][develocity-build-config-samples]_
> - _[Develocity Build Validation Scripts][develocity-build-validation-scripts]_
> - _[Develocity Open Source Projects][develocity-oss-projects]_
> - _[Common Custom User Data Maven Extension][ccud-maven-extension]_
> - _[Common Custom User Data Gradle Plugin][ccud-gradle-plugin] (this repository)_
> - _[Android Cache Fix Gradle Plugin][android-cache-fix-plugin]_
# Common Custom User Data Gradle Plugin
[](https://github.com/gradle/common-custom-user-data-gradle-plugin/actions/workflows/build-verification.yml)
[](https://plugins.gradle.org/plugin/com.gradle.common-custom-user-data-gradle-plugin)
[](https://ge.solutions-team.gradle.com/scans)
The Common Custom User Data Gradle plugin for Develocity enhances published build scans
by adding a set of tags, links and custom values that have proven to be useful for many projects building with Develocity.
You can leverage this plugin for your project in one of two ways:
1. [Apply the published plugin](#applying-the-published-plugin) directly in your build and immediately benefit from enhanced build scans
2. Copy this repository and [develop a customized version of the plugin](#developing-a-customized-version-of-the-plugin) to standardize Develocity usage across multiple projects
## Applying the published plugin
The Common Custom User Data Gradle plugin is available in the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/com.gradle.common-custom-user-data-gradle-plugin). This
plugin requires the [Develocity Gradle plugin](https://plugins.gradle.org/plugin/com.gradle.develocity) to also be applied in your build in order to have an effect.
In order for the Common Custom User Gradle plugin to become active, you need to register it in the `settings.gradle(.kts)` file of your project. The `settings.gradle(.kts)` file is the same
file where you have already declared the Develocity Gradle plugin.
See [here](settings.gradle.kts) for an example.
### Version compatibility
This table details the version compatibility of the Common Custom User Data Gradle plugin with the Develocity Gradle plugin.
| Common Custom User Data Gradle plugin versions | Develocity Gradle plugin versions | Gradle version |
| ---------------------------------------------- | ---------------------------------------- | -------------- |
| `1.0+` | `3.0+` | `5.0+` |
| `1.7+` | `1.8+` | `4.0+` |
## Captured data
The additional tags, links and custom values captured by this plugin include:
- A tag representing the operating system
- A tag representing how the build was invoked, be that from your IDE (IDEA, Eclipse, Android Studio) or from the command-line
- A tag representing builds run on CI, together with a set of tags, links and custom values specific to the CI server running the build
- For Git repositories, information on the commit id, branch name, status, and whether the checkout is dirty or not
See [CustomBuildScanEnhancements.java](./src/main/java/com/gradle/CustomBuildScanEnhancements.java) for details on what data is
captured and under which conditions.
## Configuration overrides
This plugin also allows overriding various Develocity related settings via system properties and environment variables:
- Develocity general configuration
- Remote build cache configuration
- Local build cache configuration
See [Overrides.java](./src/main/java/com/gradle/Overrides.java) for the override behavior.
You can use the system properties and environment variables to override Develocity related settings temporarily without having
to modify the build scripts. For example, to disable the local build cache when running a build:
```bash
./gradlew -Dgradle.cache.local.enabled=false build
```
Click to see the complete set of available system properties and environment variables in the table below.
### Develocity settings
| Develocity API | System property | Environment variable |
|:--------------------------------|:--------------------------------|:--------------------------------|
| develocity.server | develocity.url | DEVELOCITY_URL |
| develocity.allowUntrustedServer | develocity.allowUntrustedServer | DEVELOCITY_ALLOWUNTRUSTEDSERVER |
### Local Build Cache settings
| Local Build Cache API | System property | Environment variable |
|:-------------------------------------------------|:------------------------------------------------|:------------------------------------------------|
| buildCache.local.setEnabled | gradle.cache.local.enabled | GRADLE_CACHE_LOCAL_ENABLED |
| buildCache.local.setPush | gradle.cache.local.push | GRADLE_CACHE_LOCAL_PUSH |
| buildCache.local.setDirectory | gradle.cache.local.directory | GRADLE_CACHE_LOCAL_DIRECTORY |
| buildCache.local.setRemoveUnusedEntriesAfterDays | gradle.cache.local.removeUnusedEntriesAfterDays | GRADLE_CACHE_LOCAL_REMOVEUNUSEDENTRIESAFTERDAYS |
### HTTP Build Cache settings
| HTTP Build Cache API | System property | Environment variable |
|:-------------------------------------------|:------------------------------------------|:------------------------------------------|
| buildCache.remote.setEnabled | gradle.cache.remote.enabled | GRADLE_CACHE_REMOTE_ENABLED |
| buildCache.remote.setPush | gradle.cache.remote.push | GRADLE_CACHE_REMOTE_PUSH |
| buildCache.remote.setAllowUntrustedServer | gradle.cache.remote.allowUntrustedServer | GRADLE_CACHE_REMOTE_ALLOWUNTRUSTEDSERVER |
| buildCache.remote.setAllowInsecureProtocol | gradle.cache.remote.allowInsecureProtocol | GRADLE_CACHE_REMOTE_ALLOWINSECUREPROTOCOL |
| buildCache.remote.setUrl | gradle.cache.remote.url | GRADLE_CACHE_REMOTE_URL |
### Develocity Build Cache settings
| Develocity Build Cache API | System property | Environment variable |
|:-------------------------------------------|:---------------------------------------------|:------------------------------------------|
| buildCache.remote.setEnabled | gradle.cache.remote.enabled | GRADLE_CACHE_REMOTE_ENABLED |
| buildCache.remote.setPush | gradle.cache.remote.push | GRADLE_CACHE_REMOTE_PUSH |
| buildCache.remote.setAllowUntrustedServer | gradle.cache.remote.allowUntrustedServer | GRADLE_CACHE_REMOTE_ALLOWUNTRUSTEDSERVER |
| buildCache.remote.setAllowInsecureProtocol | gradle.cache.remote.setAllowInsecureProtocol | GRADLE_CACHE_REMOTE_ALLOWINSECUREPROTOCOL |
| buildCache.remote.setServer | gradle.cache.remote.server | GRADLE_CACHE_REMOTE_SERVER |
| buildCache.remote.setPath | gradle.cache.remote.path | GRADLE_CACHE_REMOTE_PATH |
## Developing a customized version of the plugin
For more flexibility, we recommend creating a copy of this repository so that you may develop a customized version of the plugin and publish it internally for your projects to consume.
This approach has a number of benefits:
- Tailor the build scan enhancements to exactly the set of tags, links and custom values you require
- Standardize the configuration for connecting to Develocity and the remote build cache in your organization, removing the need for each project to specify this configuration
If your customized plugin provides all required Develocity configuration, then a consumer project will get all the benefits of Develocity simply by applying the plugin. The
project sources provide a good template to get started with your own plugin.
Refer to the [Javadoc](https://docs.gradle.com/enterprise/gradle-plugin/api/) for more details on the key types available for use.
See the [Gradle User Manual](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html#custom-plugin-repositories) for more details on publishing Gradle plugins to an internal repository.
## Changelog
Refer to the [release history](https://github.com/gradle/common-custom-user-data-gradle-plugin/releases) to see detailed changes on the versions.
## Learn more
Visit our website to learn more about [Develocity][develocity].
## License
The Develocity Common Custom User Data Gradle plugin is open-source software released under the [Apache 2.0 License][apache-license].
[develocity-build-config-samples]: https://github.com/gradle/develocity-build-config-samples
[develocity-build-validation-scripts]: https://github.com/gradle/gradle-enterprise-build-validation-scripts
[develocity-oss-projects]: https://github.com/gradle/develocity-oss-projects
[ccud-gradle-plugin]: https://github.com/gradle/common-custom-user-data-gradle-plugin
[ccud-maven-extension]: https://github.com/gradle/common-custom-user-data-maven-extension
[android-cache-fix-plugin]: https://github.com/gradle/android-cache-fix-gradle-plugin
[develocity]: https://gradle.com/develocity
[apache-license]: https://www.apache.org/licenses/LICENSE-2.0.html