Package the license and repo with the plugin

Open Beginner friendly
#288 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
kotlin
Domain
build-system

Research direction

Start in the Gradle plugin publication configuration, at the gradlePlugin declaration mentioned in the issue, and inspect the generated POM for the published plugin. Compare it with the linked Dexcount POM; done means the published metadata includes the license and source repository URLs.

Written by the indexing model from the issue text.

Description

We cannot use this plugin internally because one of our tool flags it because the license is not packaged with the plugin.

For example check Dexcount Gradle Plugin. The license is properly packaged in the POM:

<licenses>
    <license>
        <name>The Apache Software License, Version 2.0</name>
        <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
        <distribution>repo</distribution>
    </license>
</licenses>

There is no license in the modules-graph-assert latest POM.

Similarly, the source repo should also be included. Again, for the dexcount-gradle-plugin it's:

<scm>
    <connection>scm:git:git://github.com/KeepSafe/dexcount-gradle-plugin.git</connection>
    <developerConnection>scm:git:ssh://git@github.com/KeepSafe/dexcount-gradle-plugin.git</developerConnection>
    <url>https://github.com/KeepSafe/dexcount-gradle-plugin/</url>
</scm>

I think by just adding vacUrl in the gradlePlugin, the license and the repo URL will be picked up automatically. See https://github.com/KeepSafe/dexcount-gradle-plugin/blob/d17e9cf40fdb6bd8f9740f2900443a660ce932a7/build.gradle#L269C1-L269C13

Dominant language
Kotlin
Stars
640
Forks
35
Avg merge
2d 21h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jraska/modules-graph-assert

All issues in jraska/modules-graph-assert

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.