Skip to content

Commit f9aef1e

Browse files
hboutemyhboutemy
authored
Fix documentation with latest changes
Update documentation after #137 and #118 Closes #146
1 parent 20990cd commit f9aef1e

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

‎src/site/markdown/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A Maven 3.x plugin to inspect the lifecycle of your project.
44

55
## Goals Overview
66

7-
The BuildPlan plugin has three goals:
7+
The BuildPlan plugin has four goals:
88

99
* [buildplan:list](list-mojo.html) displays plugin executions within a Maven project.
1010
* [buildplan:list-phase](list-phase-mojo.html) displays plugin executions within lifecycle phases.

‎src/site/markdown/usage.md.vm‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44
```
55
> mvn buildplan:list
66

7-
[INFO] --- buildplan-maven-plugin:0.1-SNAPSHOT:list (default-cli) @ buildplan-maven-plugin ---
7+
[INFO] --- buildplan-maven-plugin:${project.version}:list (default-cli) @ buildplan-maven-plugin ---
88
[INFO] --------------------------------------------------------------------------------------------------------------------
9-
[INFO] PLUGIN | PHASE | ID | GOAL
9+
[INFO] PHASE | PLUGIN | GOAL | ID
1010
[INFO] --------------------------------------------------------------------------------------------------------------------
11-
[INFO] maven-plugin-plugin | generate-sources | help-goal | helpmojo
12-
[INFO] maven-plugin-plugin | process-classes | default-descriptor | descriptor
13-
[INFO] maven-resources-plugin | process-resources | default-resources | resources
14-
[INFO] maven-compiler-plugin | compile | default-compile | compile
15-
[INFO] maven-plugin-plugin | process-classes | mojo-descriptor | descriptor
16-
[INFO] maven-resources-plugin | process-test-resources | default-testResources | testResources
17-
[INFO] maven-compiler-plugin | test-compile | default-testCompile | testCompile
18-
[INFO] maven-surefire-plugin | test | default-test | test
19-
[INFO] animal-sniffer-maven-plugin | process-classes | check-signature | check
20-
[INFO] maven-jar-plugin | package | default-jar | jar
21-
[INFO] maven-plugin-plugin | package | default-addPluginArtifactMetadata | addPluginArtifactMetadata
22-
[INFO] maven-source-plugin | package | attach-sources | jar-no-fork
23-
[INFO] license-maven-plugin | verify | default | check
24-
[INFO] maven-install-plugin | install | default-install | install
25-
[INFO] maven-deploy-plugin | deploy | default-deploy | deploy
11+
[INFO] generate-sources | maven-plugin-plugin | helpmojo | help-goal
12+
[INFO] process-classes | maven-plugin-plugin | descriptor | default-descriptor
13+
[INFO] process-resources | maven-resources-plugin | resources | default-resources
14+
[INFO] compile | maven-compiler-plugin | compile | default-compile
15+
[INFO] process-classes | maven-plugin-plugin | descriptor | mojo-descriptor
16+
[INFO] process-test-resources | maven-resources-plugin | testResources | default-testResources
17+
[INFO] test-compile | maven-compiler-plugin | testCompile | default-testCompile
18+
[INFO] test | maven-surefire-plugin | test | default-test
19+
[INFO] process-classes | animal-sniffer-maven-plugin | check | check-signature
20+
[INFO] package | maven-jar-plugin | jar | default-jar
21+
[INFO] package | maven-plugin-plugin | addPluginArtifactMetadata | default-addPluginArtifactMetadata
22+
[INFO] package | maven-source-plugin | jar-no-fork | attach-sources
23+
[INFO] verify | license-maven-plugin | check | default
24+
[INFO] install | maven-install-plugin | install | default-install
25+
[INFO] deploy | maven-deploy-plugin | deploy | default-deploy
2626
```
2727
It is possible to define the tasks used to calculate execution plan:
2828

@@ -36,7 +36,7 @@ If you want to show the lifecycle that defines the listed phase(s), add this par
3636
```
3737
> mvn buildplan:list-phase
3838

39-
[INFO] --- buildplan-maven-plugin:0.1-SNAPSHOT:list-phase (default-cli) @ buildplan-maven-plugin ---
39+
[INFO] --- buildplan-maven-plugin:${project.version}:list-phase (default-cli) @ buildplan-maven-plugin ---
4040
[INFO] install ------------------------------------------------------------------------------------------
4141
[INFO] + maven-install-plugin | default-install | install
4242
[INFO] generate-sources ---------------------------------------------------------------------------------
@@ -83,7 +83,7 @@ Also, because executions are collected per phase, direct plugin-executions are s
8383
```
8484
> mvn buildplan:list-plugin
8585

86-
[INFO] --- buildplan-maven-plugin:0.1-SNAPSHOT:list-plugin (default-cli) @ buildplan-maven-plugin ---
86+
[INFO] --- buildplan-maven-plugin:${project.version}:list-plugin (default-cli) @ buildplan-maven-plugin ---
8787
[INFO] maven-deploy-plugin -------------------------------------------------------------------------
8888
[INFO] + deploy | default-deploy | deploy
8989
[INFO] maven-source-plugin -------------------------------------------------------------------------

‎src/site/site.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
<item name="buildplan:list" href="list-mojo.html"/>
99
<item name="buildplan:list-phase" href="list-phase-mojo.html"/>
1010
<item name="buildplan:list-plugin" href="list-plugin-mojo.html"/>
11+
<item name="buildplan:report" href="report-mojo.html"/>
1112
<item name="buildplan:help" href="help-mojo.html"/>
1213
</item>
1314
<item name="Usage" href="usage.html"/>

0 commit comments

Comments
 (0)