Improve Documentation, upgrade dependencies

.github/workflows/build.yml

@@ -24,7 +24,7 @@ jobs:
 
     - uses: actions/setup-java@v2
       with:
-        distribution: 'adopt'
+        distribution: 'temurin'
         java-version: ${{ matrix.java }}
 
     - uses: gradle/wrapper-validation-action@v1

.github/workflows/codeql-analysis.yml

@@ -22,7 +22,7 @@ jobs:
 
     - uses: actions/setup-java@v2
       with:
-        distribution: 'adopt'
+        distribution: 'temurin'
         java-version: 11
 
     - name: Cache Gradle packages and wrapper

.gitignore

@@ -7,6 +7,10 @@
 /build/
 /.idea/
 /example-projects/*/.gradle
+/example-projects/*/gradle
+/example-projects/*/gradlew
+/example-projects/*/gradlew.bat
 /example-projects/*/build
 /example-projects/*/gradle.properties
+/example-projects/*/.idea
 /example-projects/multi-project/*/build

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Upgrade to [OpenFastTrace 3.2.1](https://github.com/itsallcode/openfasttrace/releases/tag/3.2.1)
   - Upgrade other dependencies
   - Build and test with Java 16. Please note that Java 16 is only supported with Gradle 7.0+.
+- [25](https://github.com/itsallcode/openfasttrace-gradle/pull/25): Upgrade build to Gradle 7.2, test with 7.0.
 
 ## [0.9.0] - 2021-05-30
 

README.md

@@ -32,6 +32,36 @@ Gradle plugin for the requirement tracing suite [OpenFastTrace](https://github.c
 
 1. Report is written to `build/reports/tracing.txt` by default.
 
+### Configuring the short tag importer
+
+The short tag importer allows omitting artifact type and the covered artifact type. Optionally you can add a prefix to the item name, e.g. a common module name.
+
+```gradle
+requirementTracing {
+  tags {
+    tag {
+      paths = fileTree(dir: 'src/').include '*.impl.*'
+      coveredItemNamePrefix = 'prefix'
+      tagArtifactType = 'impl'
+      coveredItemArtifactType = 'dsn'
+    }
+    tag {
+      paths = fileTree(dir: 'src/').include '*.test.*'
+      tagArtifactType = 'utest'
+      coveredItemArtifactType = 'dsn'
+    }
+  }
+}
+```
+
+As a benefit the tags are much shorter and contain only the name and revision:
+
+```java
+// [[tagname:1]]
+```
+
+See [multi-project/sub1](https://github.com/itsallcode/openfasttrace-gradle/tree/develop/example-projects/multi-project/sub1) for a basic example.
+
 ### Sharing requirements
 
 In bigger setups you might want to share requirements between multiple projects.
@@ -71,7 +101,7 @@ publishing {
 }
 ```
 
-See [publish-config](example-projects\publish-config) for a basic example.
+See [publish-config](https://github.com/itsallcode/openfasttrace-gradle/tree/develop/example-projects/publish-config) for a basic example.
 
 #### Importing external requirements
 
@@ -88,7 +118,7 @@ requirementTracing {
 }
 ```
 
-See [dependency-config](example-projects\dependency-config) for a basic example.
+See [dependency-config](https://github.com/itsallcode/openfasttrace-gradle/tree/develop/example-projects/dependency-config) for a basic example.
 
 ## Development
 

build.gradle

@@ -4,7 +4,7 @@ plugins {
     id 'com.gradle.plugin-publish' version '0.15.0'
     id 'com.github.hierynomus.license' version '0.16.1'
     id 'org.sonarqube' version '3.3'
-    id 'pl.droidsonroids.jacoco.testkit' version '1.0.8'
+    id 'pl.droidsonroids.jacoco.testkit' version '1.0.9'
     id 'com.github.ben-manes.versions' version '0.39.0'
 }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists