Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nebula-plugins/gradle-contacts-plugin
Structure to define the owners of a project, then contributing this back to other plugins
https://github.com/nebula-plugins/gradle-contacts-plugin
Last synced: 16 days ago
JSON representation
Structure to define the owners of a project, then contributing this back to other plugins
- Host: GitHub
- URL: https://github.com/nebula-plugins/gradle-contacts-plugin
- Owner: nebula-plugins
- License: apache-2.0
- Created: 2014-04-04T04:39:51.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-12-17T21:38:11.000Z (18 days ago)
- Last Synced: 2024-12-17T22:31:40.013Z (18 days ago)
- Language: Groovy
- Size: 1010 KB
- Stars: 14
- Watchers: 22
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Gradle Contacts Plugin
===================
[](https://plugins.gradle.org/plugin/nebula.contacts)
[](https://maven-badges.herokuapp.com/maven-central/com.netflix.nebula/gradle-contacts-plugin)
[](http://www.apache.org/licenses/LICENSE-2.0)
Plugin allows the expression of the contacts involved with a project. This data is then made available to other plugins,
to be injected in different outputs, e.g. the developers section of the POM via the nebula-publishing-plugin or the jar
manifest via the gradle-info-plugin. Each contact can be marked with a _role_ that the other plugins will use as a
discriminator. Having no _role_ indicates that the contact should be part of every _role_.
Using
----------
The simplest use is to specify a single point of contact:
```
apply plugin: 'contacts'
contacts '[email protected]'
```
Muliple people in their simple form:
apply plugin: 'nebula.contacts'
contacts '[email protected]', '[email protected]', '[email protected]'
A little bit richer, only one user:
apply plugin: 'nebula.contacts'
contacts {
'[email protected]' {
moniker 'Mickey Mouse Club'
}
}
Mix of people and teams:
apply plugin: 'nebula.contacts'
contacts {
'[email protected]' {
moniker 'Mickey Mouse Club'
}
'[email protected]' {
moniker 'Mickey Mouse'
}
'[email protected]' {
moniker 'Minnie Mouse'
github 'mmouse'
}
}
Using roles to differentiate:
apply plugin: 'nebula.contacts'
contacts {
'[email protected]'
'[email protected]' {
roles 'notify', 'owner'
}
'[email protected]' {
role 'techwriter'
}
'[email protected]'
role 'notify'
}
}
Using email validation:
apply plugin: 'nebula.contacts'
contacts {
validateEmails = true
'[email protected]' {
moniker 'Mickey Mouse Club'
}
}
Definition
----------
Each `person` takes a closure and adds a single person. A contact can configure the following fields:
* moniker - Full name of owner
* github - Github username
* twitter - Twitter handle
* role - See below.
Contacts can have `role`s specified. It can be done via these calls, which can be called multiple times:
* role(String singleRoleName)
* roles(String... roleNames)
Base Plugin
---------------
Technically the _contacts-base_ (nebula.plugin.contacts.BaseContactsPlugin) plugin is what provides the ability to specify
contacts. The _contacts_ plugin just applies the _contacts-base_, _contacts-manifest_, and _contacts-pom_ plugins. The learn
about the other plugins read below.
TBD
---------------
* Merge duplicate calls
* Formalize possible roles via a DSL
Gradle Manifest Contacts Plugin
===================
Plugin takes the contacts and stuffs them to the gradle-info-plugin, this makes them available as manifest values (for
the .jar, .rpm, a properties file). We'll publish to tags, Module-Owner and Module-Email. Module-Owner is a common separated
list of all contacts that have the "owner" role (or no role). Module-Email is a common separated list of
contacts that want to be notified when changes are made to this module, they have to have the role of "notify"
(or no role). We're assuming that multiple owners are allowed, and we can just comma separate them.
buildscript {
repositories { mavenCentral() }
dependencies { classpath 'com.netflix.nebula:gradle-contacts-plugin:1.9.+' }
dependencies { classpath 'com.netflix.nebula:nebula-publishing-plugin:1.9.+' }
}
apply plugin: 'nebula.contacts-base'
apply plugin: 'nebula.contacts-manifest'
apply plugin: 'info'
contacts {
'[email protected]' {
roles 'owner'
}
'[email protected]' { }
'[email protected]' {
role 'notify'
}
}
Would produce the following values in build/manifest/info.properties:
[email protected],[email protected]
[email protected],[email protected]
Gradle POM Contacts Plugin
===================
Plugin takes all the contacts and adds them to the developers section of the POM if using the nebula-publishing-plugin.
apply plugin: 'nebula.contacts-base'
apply plugin: 'contacts-pom'
apply plugin: 'nebula-maven-publishing'
contacts {
'[email protected]' {
roles 'owner'
}
'[email protected]' {
moniker 'Billy Bob'
}
'[email protected]' {
role 'notify'
}
}
Would produce a section in the POM like this:
bob1978
[email protected]
owner
Billy Bob
[email protected]
[email protected]
notify
Mapping to POMs
---------------
POMs support very rich definitions for developers and contributors (https://maven.apache.org/pom.html#Developers). Though,
a quick analysis shows that these are rarely very complete. This plugin isn't targeting to support all the POM fields,
but this could be possible in the future. The primary goal of this plugin is to identify one or two primary contact of
the project, with the expectation that communication with developers/collaborators would be done via a mailing list and
not trolling the POM file.