Skip to content
This repository has been 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
rmlekus opened this issue Oct 27, 2019 · 2 comments
Labels
help wanted We are looking for contributors for this issue Prio: Medium Medium Priority Status: Accepted Issue or PR is accepted Type: Bug Issue or PR type is a bug

Comments

@rmlekus
Copy link
Contributor

rmlekus commented Oct 27, 2019

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 installed 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.
@rmlekus rmlekus added Prio: Triage Triage Priority Status: Pending Issue or PR awaits response Type: Bug Issue or PR type is a bug labels Oct 27, 2019
@holzerma holzerma added Hacktoberfest https://hacktoberfest.digitalocean.com/ help wanted We are looking for contributors for this issue Prio: Medium Medium Priority Status: Accepted Issue or PR is accepted and removed Prio: Triage Triage Priority Status: Pending Issue or PR awaits response labels Oct 28, 2019
@holzerma
Copy link
Member

thanks for the hint. we should definetly fix this. pull requests are highly welcome!

@pfistererm
Copy link
Contributor

While a publily avaulable buil version of the licensescout is desirable, I do not consider it necessary to update a version number in an example in the documentation for each new version. "Template processing" is definitely over-engineered. After all, we provide a complete example of a real project (org.aposin.licensescout.licensereport, and see also org.aposin.licensescout.quickstart), which has the correct snapshot version number to work out-of-the box.
The README.md (which newcomers are assumed to read first) already hints to org.aposin.licensescout.quickstart very prominently.
Maybe we could add another reference to org.aposin.licensescout.licensereport and org.aposin.licensescout.quickstart in the file documentation.adoc.

@aposin-bot aposin-bot removed the Hacktoberfest https://hacktoberfest.digitalocean.com/ label Nov 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted We are looking for contributors for this issue Prio: Medium Medium Priority Status: Accepted Issue or PR is accepted Type: Bug Issue or PR type is a bug
Development

No branches or pull requests

4 participants