Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TRG 7.04: added eclipse dash tool usage example and pom config #371

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/release/trg-7/trg-7-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,51 @@ You can request the status of your used libraries via the [Dash Licence Tool](ht
- Provide support if an issue is labeled with "Help wanted"
- Add the summary as DEPENDENCY file to the according repository (root level)

**Example usage:**

Make sure to also include test dependencies. For a maven-based java project you can configure the maven plugin as follows to include test-depenencies:

``` xml
<pluginRepositories>
<pluginRepository>
<id>dash-licenses-snapshots</id>
<url>https://repo.eclipse.org/content/repositories/dash-licenses-snapshots/</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
<!-- other stuff -->
<plugin>
<groupId>org.eclipse.dash</groupId>
<artifactId>license-tool-plugin</artifactId>
<!-- see https://repo.eclipse.org/content/repositories/dash-licenses-snapshots/org/eclipse/dash/license-tool-plugin/ -->
<version>1.0.3-SNAPSHOT</version>
<configuration>
<projectId>automotive.tractusx</projectId>
<!-- name of dependencies file -->
<summary>DEPENDENCIES</summary>
<!-- include test dependencies -->
<includeScope>test</includeScope>
</configuration>
<executions>
<execution>
<id>license-check</id>
<goals>
<goal>license-check</goal>
</goals>
</execution>
</executions>
</plugin>
```

You then can invoke the plugin from command line as follows:

``` sh
# same directory as you pom.xml
mvn org.eclipse.dash:license-tool-plugin:license-check
```

**Important Notes:**

- Get your API Token (see README of the Dash Tool), note that only committers can get an API Token
Expand Down