Skip to content

Commit 1157cd0

Browse files
Update README.md to use version 0.8.0
1 parent 29d21f3 commit 1157cd0

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ If you use an old JDK release of your chosen Java version, you may encounter iss
3232
Run the following command from the root of your project (the source code does not need to be built):
3333

3434
```bash
35-
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.7.1:htmlReport
35+
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.8.0:htmlReport
3636
```
3737
View the report at ```target/site/refactor-first-report.html```
3838

3939
### [As Part of GitHub Actions Output](https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/)
4040
This will generate a simplified HTML report (no graphs or images) as the output of a GitHub Action step
4141
```bash
4242
mvn -B clean test \
43-
org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.7.1:simpleHtmlReport \
43+
org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.8.0:simpleHtmlReport \
4444
&& echo "$(cat target/site/refactor-first-report.html)" >> $GITHUB_STEP_SUMMARY
4545
```
4646

@@ -53,7 +53,7 @@ Add the following to your project in the build section. **showDetails** will sh
5353
<plugin>
5454
<groupId>org.hjug.refactorfirst.plugin</groupId>
5555
<artifactId>refactor-first-maven-plugin</artifactId>
56-
<version>0.7.1</version>
56+
<version>0.8.0</version>
5757
<!-- optional -->
5858
<configuration>
5959
<showDetails>false</showDetails>
@@ -74,7 +74,7 @@ A RefactorFirst report will show up in the site report when you run ```mvn site`
7474
<plugin>
7575
<groupId>org.hjug.refactorfirst.plugin</groupId>
7676
<artifactId>refactor-first-maven-plugin</artifactId>
77-
<version>0.7.1</version>
77+
<version>0.8.0</version>
7878
</plugin>
7979
...
8080
</plugins>
@@ -85,17 +85,17 @@ A RefactorFirst report will show up in the site report when you run ```mvn site`
8585
Care has been taken to use sensible defaults, though if you wish to override these defaults you can specify the following parameters.
8686
Specify with -D if running on the command line. e.g. ```-DbackEdgeAnalysisCount=0 `DanalyzeCycles=false``` or in the configuration section (as in the above examples) if including in a Maven build.
8787

88-
|Option|Action|Default|
89-
|------|------|-------|
90-
|showDetails|Shows God Class metrics|false|
91-
|backEdgeAnalysisCount|Number of back edges in a cycle to analyze. <br>If total number of back edges is greater than the value specified, it analyzes the number of minimum weight edges specified.<br>**If 0 is specified, all back edges will be analyzed**|50|
92-
|analyzeCycles|Analyzes the 10 largest cycles (will be configurable in the future)|true|
93-
|minifyHtml|Minifies the generated HTML report. Only available on ```htmlReport``` and ```simpleHtmlReport``` goals. May cause issues with large reports.|false|
94-
|excludeTests|Exclude test classes from analysis|true|
95-
|testSrcDirectory|Excludes classes containing this pattern from analysis|```src/test``` and ```src/test```|
96-
|projectName|The name of your project to be displayed on the report|Your Maven project name|
97-
|projectVersion|The version of your project to be displayed on the report|Your Maven project version|
98-
|outputDirectory|The location the project report will be written|```${projectDir}/target/site/refactor-first-report.html```
88+
|Option|Action| Default |
89+
|------|------|-----------------------------------------------------------|
90+
|showDetails|Shows God Class metrics| false |
91+
|backEdgeAnalysisCount|Number of back edges in a cycle to analyze. <br>If total number of back edges is greater than the value specified, it analyzes the number of minimum weight edges specified.<br>**If 0 is specified, all back edges will be analyzed**| 50 |
92+
|analyzeCycles|Analyzes the 10 largest cycles (will be configurable in the future)| true |
93+
|minifyHtml|Minifies the generated HTML report. Only available on ```htmlReport``` and ```simpleHtmlReport``` goals. May cause issues with large reports.| false |
94+
|excludeTests|Exclude test classes from analysis| true |
95+
|testSrcDirectory|Excludes classes containing this pattern from analysis| ```src/test``` and ```src\test``` |
96+
|projectName|The name of your project to be displayed on the report| Your Maven project name |
97+
|projectVersion|The version of your project to be displayed on the report| Your Maven project version |
98+
|outputDirectory|The location the project report will be written| ```${projectDir}/target/site/refactor-first-report.html```
9999

100100

101101
### Seeing Errors?
@@ -139,7 +139,7 @@ I would like to create a Gradle plugin and (possibly) support non-conventional p
139139
and then (assuming Maven is installed) run
140140

141141
```bash
142-
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.7.1:htmlReport
142+
mvn org.hjug.refactorfirst.plugin:refactor-first-maven-plugin:0.8.0:htmlReport
143143
```
144144

145145
## Viewing the Report

0 commit comments

Comments
 (0)