This repository was archived by the owner on Dec 20, 2022. It is now read-only.
This repository was archived by the owner on Dec 20, 2022. It is now read-only.
Documentation: README.md/documentation.md usage examples reference non existing plugin version #56
Open
Description
In the projects README.md
as well as the description in the 'full documentation' refered to by the README.md
the version 1.1.4
of the plugin is referenced.
<groupId>org.aposin.licensescout</groupId>
<artifactId>licensescout-maven-plugin</artifactId>
<version>1.1.4</version>
Bug Report (Documentation Bug)
This version is not available on any public maven repository, nor can it be re-produced by e.g. building a tag/branch of the aposin/LicenseScout repository.
Since the plugin has not yet been published to a public maven repository (see #22 ), I would suggest to update the readme to describe the required process of using the plugin is
- the SNAPSHOT version of the plugin needs to be
mvn install
ed locally - the README.md template should refer to
org.aposin.licensescout.core/pom.xml#L14:
<groupId>org.aposin.licensescout</groupId>
<artifactId>licensescout-maven-plugin</artifactId>
<version>1.3.1-SNAPSHOT</version>
Expected Behavior - What where you expecting to happen?
Starting to use the LicenseScout maven plugin should be possible by reading the README / documentation by simple 'cut & paste' of the given examples/process.
Possible Solution
- Step 1: manually fix the documentation
- Step 2: add template processing for documentation.md and README.md to take over the
newest version of the provided plugin & template configuration upon release to a
public repository once LicenseScout should be released on Maven central #22 is implemented.