Make license used for pom configurable #760

epeee · 2018-09-26T16:37:48Z

Very first draft (#755).

This pr extends shipkit configuration in a way that we have to configure the license used (incl url now).

shipkit {
    ...

    licenseInfo.license = "Eclipse Public License v2.0"
    licenseInfo.url = "http://www.eclipse.org/legal/epl-v20.html"
}

This will end up in a pom like

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  ...
  <licenses>
    <license>
      <name>Eclipse Public License v2.0</name>
      <url>http://www.eclipse.org/legal/epl-v20.html</url>
      <distribution>repo</distribution>
    </license>
  </licenses>
  ...

The downside of this approach is that we still have to configure the license used by gradle bintray plugin, e.g.:

        bintray {
            pkg {
                ...
                licenses = ['EPL-2.0']
        ...

We could add this one also to shipkit config and do the configuration in our gradle plugin. As a result we'd have the license config in one place.

Note: this is a breaking change and will cause builds without a shipkit.licenseInfo configuration to fail:

Execution failed for task ':api:generatePomFileForJavaLibraryPublication'.
> Could not apply withXml() to generated POM
   > Please configure 'shipkit.licenseInfo.license' value (String).

```

mstachniuk · 2018-09-28T07:44:34Z

@epeee Maybe you can read somehow Bintray plugin property to avoid duplication?
@mockitoguy any hint?

jpkrohling · 2018-10-09T08:00:46Z

Any updates on this one?

jpkrohling · 2018-10-15T15:23:54Z

Bump?

mockitoguy · 2018-10-24T02:16:43Z

Looking at it. I met @epeee at CodeOne conference and he mentioned that his PR needs bump. @jpkrohling, sorry for slow turnaround! I'm on it.

mockitoguy · 2018-10-24T15:28:16Z

Hey @epeee, I will review and provide my feedback shortly. In the meantime, I commented on the ticket so that @jpkrohling is unblocked and can customize the pom.

mstachniuk · 2019-02-04T08:48:41Z

I found a hack how to get license info from bintray configuration. @epeee @mockitoguy WDYT?

        Object bintray = project.getExtensions().findByName("bintray");

        try {
            Method getPkg = bintray.getClass().getDeclaredMethod("getPkg");
            getPkg.setAccessible(true);
            Object pkg = getPkg.invoke(bintray);
            Field licensesField = pkg.getClass().getDeclaredField("licenses");
            licensesField.setAccessible(true);
            String[] licenses = (String[]) licensesField.get(pkg);
            for (String license : licenses) {
                LOG.lifecycle(" lic " + license);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }

mockitoguy · 2019-03-11T16:24:08Z

I found a hack how to get license info from bintray configuration

Please no :) That's a lot of complexity for little benefit.

mstachniuk · 2019-03-11T20:01:43Z

It's a simple reflection ;-) But as you wish!

mockitoguy

I like it. Let's update the defaults and ship it.

mockitoguy · 2019-03-16T04:29:06Z

subprojects/shipkit/src/main/groovy/org/shipkit/internal/gradle/util/PomCustomizer.java

@@ -76,8 +76,8 @@ static void customizePom(Node root, ShipkitConfiguration conf,
        }

        Node license = root.appendNode("licenses").appendNode("license");
-        license.appendNode("name", "The MIT License");
-        license.appendNode("url", repoLink + "/blob/master/LICENSE");
+        license.appendNode("name", conf.getLicenseInfo().getLicense());


Can we add defaults, Apache 2.0 and blob/master/LICENSE?

Sure, good feedback, thx!

Cool. Let me know when you're ready.

MIT is 30y old and lawyers no longer like it. Let's default to Apache 2.0.

mockitoguy · 2019-03-16T04:31:08Z

Once we merge it, can we get the license value populated to the Bintray extension, too? Thanks!!! Nice change!

mockitoguy · 2019-03-16T18:07:53Z

Before merging, we need to add defaults (as my comment) or make it "lenient". I suggest to add defaults because it is simpler and more useful. Then we can merge :) Let me know when you're ready!

mstachniuk

See my and Szczepan's comments. For me, it's not ready yet.

mstachniuk · 2019-04-01T06:59:31Z

subprojects/shipkit/src/main/groovy/org/shipkit/gradle/configuration/ShipkitConfiguration.java

@@ -231,6 +236,24 @@ public void setWriteAuthToken(String writeAuthToken) {
        }
    }

+    public class LicenseInfo {


what about distribution property in pom?

mstachniuk · 2019-04-01T07:00:02Z

subprojects/shipkit/src/main/groovy/org/shipkit/gradle/configuration/ShipkitConfiguration.java

@@ -95,6 +96,10 @@ public ReleaseNotes getReleaseNotes() {
        return releaseNotes;
    }

+    public LicenseInfo getLicenseInfo() {


How to now configure a few licenses? E.g. one open source and one commercial?

mockitoguy suggested changes Mar 16, 2019

View reviewed changes

Make license used for pom configurable

dce776d

epeee force-pushed the ep branch from d257d73 to dce776d Compare March 16, 2019 08:28

mstachniuk suggested changes Apr 1, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make license used for pom configurable #760

Make license used for pom configurable #760

epeee commented Sep 26, 2018

mstachniuk commented Sep 28, 2018

jpkrohling commented Oct 9, 2018

jpkrohling commented Oct 15, 2018

mockitoguy commented Oct 24, 2018

mockitoguy commented Oct 24, 2018

mstachniuk commented Feb 4, 2019

mockitoguy commented Mar 11, 2019

mstachniuk commented Mar 11, 2019

mockitoguy left a comment

mockitoguy Mar 16, 2019

epeee Mar 16, 2019

mockitoguy Mar 16, 2019

mockitoguy commented Mar 16, 2019

mockitoguy commented Mar 16, 2019

mstachniuk left a comment

mstachniuk Apr 1, 2019

mstachniuk Apr 1, 2019

Make license used for pom configurable #760

Are you sure you want to change the base?

Make license used for pom configurable #760

Conversation

epeee commented Sep 26, 2018

mstachniuk commented Sep 28, 2018

jpkrohling commented Oct 9, 2018

jpkrohling commented Oct 15, 2018

mockitoguy commented Oct 24, 2018

mockitoguy commented Oct 24, 2018

mstachniuk commented Feb 4, 2019

mockitoguy commented Mar 11, 2019

mstachniuk commented Mar 11, 2019

mockitoguy left a comment

Choose a reason for hiding this comment

mockitoguy Mar 16, 2019

Choose a reason for hiding this comment

epeee Mar 16, 2019

Choose a reason for hiding this comment

mockitoguy Mar 16, 2019

Choose a reason for hiding this comment

mockitoguy commented Mar 16, 2019

mockitoguy commented Mar 16, 2019

mstachniuk left a comment

Choose a reason for hiding this comment

mstachniuk Apr 1, 2019

Choose a reason for hiding this comment

mstachniuk Apr 1, 2019

Choose a reason for hiding this comment