Inside a company using Gradle, there can be an explosion of plugins. There are a few ways to manage them, but it can be hard to find useful pieces of information about the available plugins:
- What plugins are available?
- Where can I find docs about a plugin?
- What versions of the plugin should I use?
This plugin portal aims to solve all of these issues.
This project consists of two parts:
- A service that provides a 'manifest' of plugins and repositories.
- A plugin to make gradle consume the services API and provide a way to resolve plugins though the service.
First you need to make Gradle aware of the plugins. To do this you can add something like (changing the URL are appropriate). To the top of your settings.gradle.
apply from: 'http://localhost:8080/api/v1/resource'
Curling this address will return something like
buildscript {
repositories {
ivy {
url "${System.getProperty("user.home")}/local-repo"
layout 'pattern', {
ivy '[organisation]/[module]/[revision]/[module]-[revision].ivy'
artifact '[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier]).[ext]'
m2compatible = true
}
}
maven {
url "http://repo.example.com/m2"
}
}
dependencies {
classpath 'com.linkedin.gradle.portal:plugin-portal-plugin:+'
}
}
gradle.getStartParameter().getProjectProperties()['plugin.portal.host'] = 'http://localhost:8080/'
apply plugin: com.linkedin.portal.plugin.ConfigurePluginRepositories
The buildscript.repositories entry is generated from repositories that are defined in /api/v1/manifest/repository.
The gradle.getStartParameter().getProjectProperties()['plugin.portal.host'] = 'http://localhost:8080/' line is also auto
generated. The URL is based on the URL used in your settings.gradle file. This allows the plugin that gets applied to
know which host to talk to.
The above code snippet configures some repositories (the same one the service will serve), configures a property, then applies a
plugin (located in the plugin-portal-plugin module).
The ConfigurePluginRepositories plugin, when applied, will hit <host>/api/v1/manifest to get the listing of all
plugins and repositories. This will generate a single request, and will be cached when offline.
After the request has been made, the repositories contained in the manifest will be registers. To see how this is done
check out com.linkedin.portal.plugin.internal.RepositoryConfigurationAction. When the repositories are registered
then plugin information will be provided via the com.linkedin.portal.plugin.internal.ResolutionStrategyAction class.
For more details on how either of these classes work, please review their respective documentation.
When Gradle exits the initialization phase, the plugins {} will then be able to use plugins registered with the service.
| Method | Endpoint | Auth Required |
|:------:|:---------------------------------------:|:-------------:|
| GET | /api/v1/manifest | NO |
| GET | /api/v1/resource | NO |
| GET | /api/v1/resource | NO |
| GET | /api/v1/manifest/plugins | NO |
| POST | /api/v1/manifest/plugins | YES |
| GET | /api/v1/manifest/plugins/{id} | NO |
| DELETE | /api/v1/manifest/plugins/{id}/{version} | YES |
| POST | /api/v1/manifest/plugins/{id} | YES |
| GET | /api/v1/manifest/plugins/{id}/{version} | NO |
| GET | /api/v1/manifest/repository | NO |
| POST | /api/v1/manifest/repository | YES |
| GET | /api/v1/manifest/repository/{id} | NO |
| DELETE | /api/v1/manifest/repository/{id} | YES |
We have enabled security by default. Since every organization will have different security requirements we highly recommend that you update the authentication system used. Spring has great integration with LDAP, OAuth, database password. Please change from the BASIC auth with a pre-defined username and password to keep your data secure.
## Create Main Repo
curl -X "POST" "http://localhost:8080/api/v1/manifest/repository" \
-H "Content-Type: application/json; charset=utf-8" \
-u user:password \
-d $'{
"type": "IVY",
"url": "http://artifactory.corp.linkedin.com:8081/artifactory/release",
"layout": {
"ivy": "[organisation]/[module]/[revision]/[module]-[revision].ivy",
"artifact": "[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier]).[ext]",
"m2compatible": true
}
}'
## Create Local Repo
curl -X "POST" "http://localhost:8080/api/v1/manifest/repository" \
-H "Content-Type: application/json; charset=utf-8" \
-u user:password \
-d $'{
"type": "IVY",
"url": "${System.getProperty(\\"user.home\\")}/local-repo",
"layout": {
"ivy": "[organisation]/[module]/[revision]/[module]-[revision].ivy",
"artifact": "[organisation]/[module]/[revision]/[artifact]-[revision](-[classifier]).[ext]",
"m2compatible": true
}
}'
## Create Gradle Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json; charset=utf-8" \
-u user:password \
-d $'{
"pluginId": "com.gradle.build-scan",
"defaultVersion": "1.7.4",
"versions": {
"1.6": {
"version": "1.6",
"dependencyNotation": {
"group": "com.gradle",
"name": "build-scan-plugin",
"version": "1.6"
}
},
"1.7.4": {
"version": "1.7.4",
"dependencyNotation": {
"group": "com.gradle",
"name": "build-scan-plugin",
"version": "1.7.4"
}
}
}
}'
## Create Biz Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json; charset=utf-8" \
-u user:password \
-d $'{
"pluginId": "biz.linkedin.core",
"defaultVersion": "0.0.3",
"versions": {
"0.0.3": {
"version": "0.0.3",
"dependencyNotation": {
"group": "com.linkedin.gradle-core-biz-plugins",
"name": "base-plugins",
"version": "0.0.3"
}
}
}
}'
## Create li-product Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json; charset=utf-8" \
-u user:password \
-d $'{
"pluginId": "li-product",
"defaultVersion": "2.1.18",
"versions": {
"2.1.18": {
"version": "2.1.18",
"dependencyNotation": {
"group": "com.linkedin.ligradle-jvm",
"name": "product-plugins",
"version": "2.1.18"
}
}
}
}'
## Create li-android Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "li-android",
"defaultVersion": "3.0.12",
"versions": {
"3.0.12": {
"version": "3.0.12",
"dependencyNotation": {
"group": "com.linkedin.ligradle-android-plugins",
"name": "gradle-android",
"version": "3.0.12"
}
}
}
}'
## Create li-productivity Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "li-productivity",
"defaultVersion": "0.0.47",
"versions": {
"0.0.47": {
"version": "0.0.47",
"dependencyNotation": {
"group": "com.linkedin.gradle-productivity",
"name": "productivity-plugins",
"version": "0.0.47"
}
}
}
}'
## Create emulator-plugin Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "emulator-plugin",
"defaultVersion": "0.0.40",
"versions": {
"0.0.40": {
"version": "0.0.40",
"dependencyNotation": {
"group": "com.linkedin.android-emulator-plugin",
"name": "gradle-emulator-plugin",
"version": "0.0.40"
}
}
}
}'
## Create li-android-test Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "li-android-test",
"defaultVersion": "0.3.11",
"versions": {
"0.3.11": {
"version": "0.3.11",
"dependencyNotation": {
"group": "com.linkedin.mntf-android-plugins",
"name": "gradle-android-test",
"version": "0.3.11"
}
}
}
}'
## Create lix-cleanup Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "lix-cleanup",
"defaultVersion": "0.1.29",
"versions": {
"0.1.29": {
"version": "0.1.29",
"dependencyNotation": {
"group": "com.linkedin.lix-cleanup-plugin",
"name": "gradle-lix-cleanup",
"version": "0.1.29"
}
}
}
}'
## Create tracking-constants Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "tracking-constants",
"defaultVersion": "0.1.6",
"versions": {
"0.1.6": {
"version": "0.1.6",
"dependencyNotation": {
"group": "com.linkedin.tracking-constants",
"name": "gradle-tracking-constants",
"version": "0.1.6"
}
}
}
}'
## Create li-testmanager Plugin
curl -X "POST" "http://localhost:8080/api/v1/manifest/plugins" \
-H "Content-Type: application/json" \
-u user:password \
-d $'{
"pluginId": "li-testmanager",
"defaultVersion": "1.0.1",
"versions": {
"1.0.1": {
"version": "1.0.1",
"dependencyNotation": {
"group": "com.linkedin.gradle-testmanager",
"name": "gradle-testmanager",
"version": "1.0.1"
}
}
}
}'