Skip to content

Commit 9147813

Browse files
committed
Update documentation for v0.1.2 release, including changelog and usage instructions.
1 parent 7025f60 commit 9147813

4 files changed

Lines changed: 35 additions & 25 deletions

File tree

docs/src/process-development/linter-tool/changelog.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22
title: Changelog
33
icon: code
44
---
5+
## Version 0.1.2 (Latest)
56

6-
### Version 0.1.1 (Latest)
7+
### Bug Fixes
8+
9+
- **Fixed false positive class hierarchy checks for V1 plugins** — The linter incorrectly reported that implementation classes did not implement `JavaDelegate`, did not extend `AbstractServiceDelegate` / `AbstractTaskMessageSend`, or that execution listeners did not implement `ExecutionListener`. This was caused by missing Spring Framework classes in the shaded CLI JAR, which prevented the JVM from resolving plugin class hierarchies at runtime. Spring artifacts (`spring-beans`, `spring-core`, `spring-jcl`) are now explicitly included in the shade configuration.
10+
11+
- **Fixed version mismatch between `linter-cli` and `linter-core`**`linter-cli` referenced a hardcoded dependency on `linter-core:0.1.0` instead of the current project version, causing stale artifacts to be used during the build. The version is now derived from `${project.version}`.
12+
13+
**Upgrade is strongly recommended for all users of v0.1.1.**
14+
15+
16+
### Version 0.1.1
717
- **Bugfix: DSF API v2 Plugin Discovery (`CLASS_LOADING_FAILED`)**:
818
- Fixed a bug where linting a JAR built against **DSF API v2** (`dev.dsf.bpe.v2.ProcessPluginDefinition`) failed with `CLASS_LOADING_FAILED` and the message `Failed to load plugin class: dev/dsf/bpe/v2/AbstractProcessPluginDefinition`
919
- **Root Cause**: The linter's shaded JAR only included `dsf-bpe-process-api-v1`; the v2 API classes were absent at runtime

docs/src/process-development/linter-tool/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ vim linter-core/src/main/java/dev/dsf/linter/service/BpmnLintingService.java
7676
mvn clean package -DskipTests
7777

7878
# 3. Test with a sample plugin
79-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
79+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
8080
--path test-plugin.jar --html --verbose
8181

8282
# 4. Check the generated report
@@ -97,7 +97,7 @@ git commit -m "Description of changes"
9797
```bash
9898
# Start the linter with debugger enabled
9999
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 \
100-
-jar linter-cli/target/linter-cli-0.1.1.jar \
100+
-jar linter-cli/target/linter-cli-0.1.2.jar \
101101
--path plugin.jar --html --verbose
102102

103103
# Attach debugger from IDE to localhost:5005

docs/src/process-development/linter-tool/linter-tool.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,11 @@ mvn clean package -X
6464

6565
```bash
6666
# Lint a local JAR file
67-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
67+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
6868
--path your-plugin.jar --html
6969

7070
# Lint a remote JAR file
71-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
71+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
7272
--path https://github.com/datasharingframework/dsf-process-ping-pong/releases/download/v2.0.0.1/dsf-process-ping-pong-2.0.0.1.jar --html
7373

7474
# View report at: /tmp/dsf-linter-report-<name>/dsf-linter-report/index.html
@@ -93,7 +93,7 @@ cd dsf-linter
9393
mvn clean package
9494

9595
# The executable JAR will be at:
96-
# linter-cli/target/linter-cli-0.1.1.jar
96+
# linter-cli/target/linter-cli-0.1.2.jar
9797
```
9898

9999
### Distribution
@@ -102,7 +102,7 @@ The linter is distributed as a single executable JAR file that includes all depe
102102

103103
```bash
104104
# Copy to a convenient location
105-
cp linter-cli/target/linter-cli-0.1.1.jar ~/bin/dsf-linter.jar
105+
cp linter-cli/target/linter-cli-0.1.2.jar ~/bin/dsf-linter.jar
106106

107107
# Use from anywhere
108108
java -jar ~/bin/dsf-linter.jar --path plugin.jar --html
@@ -154,48 +154,48 @@ plugin.jar
154154

155155
```bash
156156
# Local JAR file
157-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
157+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
158158
--path C:\path\to\plugin.jar --html
159159

160160
# Remote JAR file
161-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
161+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
162162
--path https://github.com/datasharingframework/dsf-process-ping-pong/releases/download/v2.0.0.1/dsf-process-ping-pong-2.0.0.1.jar --html
163163
```
164164

165165
#### Advanced Configuration
166166

167167
```bash
168168
# Multiple report formats with custom path
169-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
169+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
170170
--path plugin.jar --html --json --report-path ./reports
171171

172172
# Verbose output (colors enabled by default, use --no-color to disable)
173-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
173+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
174174
--path plugin.jar --html --verbose
175175

176176
# Lint Maven project (two-step process)
177177
# Step 1: Build the project
178178
cd /path/to/project && mvn clean package
179179

180180
# Step 2: Lint the resulting JAR
181-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
181+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
182182
--path /path/to/project/target/my-plugin-1.0.0.jar --html
183183
```
184184

185185
#### CI/CD Integration
186186

187187
```bash
188188
# GitHub Actions / GitLab CI
189-
FORCE_COLOR=1 java -jar linter-cli/target/linter-cli-0.1.1.jar \
189+
FORCE_COLOR=1 java -jar linter-cli/target/linter-cli-0.1.2.jar \
190190
--path plugin.jar --html --json --verbose
191191

192192
# Jenkins (fail on errors)
193-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
193+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
194194
--path plugin.jar --html
195195
# Exit code: 0 = success, 1 = errors
196196

197197
# Don't fail build (gradual adoption)
198-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
198+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
199199
--path plugin.jar --html --no-fail
200200
```
201201

docs/src/process-development/linter-tool/troubleshooting.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ icon: config
1212
**Solution**:
1313
```bash
1414
# Wrong - Maven project directly
15-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
15+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
1616
--path /path/to/project --html
1717

1818
# Correct - Build first, then lint JAR
1919
cd /path/to/project && mvn clean package
20-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
20+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
2121
--path /path/to/project/target/my-plugin-1.0.0.jar --html
2222
```
2323

@@ -29,11 +29,11 @@ java -jar linter-cli/target/linter-cli-0.1.1.jar \
2929

3030
```bash
3131
# Windows
32-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
32+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
3333
--path "C:\Users\Username\project\target\plugin.jar" --html
3434

3535
# Linux/Mac
36-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
36+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
3737
--path /home/username/project/target/plugin.jar --html
3838
```
3939

@@ -47,7 +47,7 @@ java -jar linter-cli/target/linter-cli-0.1.1.jar \
4747
ls ~/.m2/settings.xml
4848

4949
# Use verbose mode to see detailed error messages
50-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
50+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
5151
--path plugin.jar --html --verbose
5252

5353
# Check if dependencies are in the JAR
@@ -61,11 +61,11 @@ jar -tf plugin.jar | grep -i "class"
6161
**Solution**:
6262
```bash
6363
# --html or --json flag must be set
64-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
64+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
6565
--path plugin.jar --html # ← Required
6666

6767
# Use absolute path for report directory
68-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
68+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
6969
--path plugin.jar --html --report-path $(pwd)/reports
7070

7171
# Check write permissions
@@ -88,7 +88,7 @@ ls -lh test.jar
8888
ping example.com
8989

9090
# Then use the local file
91-
java -jar linter-cli/target/linter-cli-0.1.1.jar \
91+
java -jar linter-cli/target/linter-cli-0.1.2.jar \
9292
--path test.jar --html
9393
```
9494

@@ -110,11 +110,11 @@ java -jar linter-cli/target/linter-cli-0.1.1.jar \
110110
**Solution**:
111111
```bash
112112
# Increase heap size
113-
java -Xmx2g -jar linter-cli/target/linter-cli-0.1.1.jar \
113+
java -Xmx2g -jar linter-cli/target/linter-cli-0.1.2.jar \
114114
--path plugin.jar --html
115115

116116
# For very large projects
117-
java -Xmx4g -Xms1g -jar linter-cli/target/linter-cli-0.1.1.jar \
117+
java -Xmx4g -Xms1g -jar linter-cli/target/linter-cli-0.1.2.jar \
118118
--path plugin.jar --html
119119
```
120120

0 commit comments

Comments
 (0)