Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@guillermocalvo
guillermocalvo committed Jul 29, 2024
1 parent a653c59 commit 6feb875
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/site/markdown/AntTask.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ The following table gives an overview of all available parameters of the Ant tas
| classpath | true | n.a. | Classpath for the dependencies used to compare old and new versions. |
| classpathref | true | n.a. | Classpath reference for the dependencies used to compare old and new versions. |
| semanticVersioning | true | false | Indicate which part of the version to increment according to semantic versioning rules. |
| markdown | true | false | Generates output in Markdown format. |
| onlyBinaryIncompatible | true | false | If true, output only binary incompatible changes. |
| onlyModified | true | false | If true, output only modified classes/methods, else print all classes and methods.|
| includeSynthetic | true | false | If true, track changes for synthetic classes and class members.|
Expand Down
4 changes: 4 additions & 0 deletions src/site/markdown/CliTool.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ SYNOPSIS
[--old-classpath <oldClassPath>]
[--report-only-filename] [--report-only-summary]
[(-s | --semantic-versioning)]
[--markdown]
[(-x <pathToXmlOutputFile> | --xml-file <pathToXmlOutputFile>)]
[--error-on-binary-incompatibility]
[--error-on-source-incompatibility]
Expand Down Expand Up @@ -105,6 +106,9 @@ OPTIONS
-s, --semantic-versioning
Tells you which part of the version to increment.
--markdown
Generates output in Markdown format.
-x <pathToXmlOutputFile>, --xml-file <pathToXmlOutputFile>
Provides the path to the xml output file.
Expand Down
5 changes: 5 additions & 0 deletions src/site/markdown/MavenPlugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ The following properties can be set:
| japicmp.skip | Skip the execution of this plugin. |
| japicmp.skipXmlReport | Skip the generation of the XML report. |
| japicmp.skipHtmlReport | Skip the generation of the HTML report. |
| japicmp.skipMarkdownReport | Skip the generation of the Markdown report. |
| japicmp.breakBuildOnModifications | Break the build in case of any modifications. |
| japicmp.breakBuildOnBinaryIncompatibleModifications | Break the build in case of any binary incompatible modifications. |
| japicmp.breakBuildOnSourceIncompatibleModifications | Break the build in case of any source incompatible modifications. |
Expand Down Expand Up @@ -172,6 +173,7 @@ An advanced configuration can utilize the following parameters:
<skipPomModules>true</skipPomModules>
<htmlStylesheet>path/to/stylesheet.css</htmlStylesheet>
<htmlTitle>Title of report</htmlTitle>
<markdownTitle>Title of report</markdownTitle>
<noAnnotations>false</noAnnotations>
<ignoreNonResolvableArtifacts>false</ignoreNonResolvableArtifacts>
<ignoreMissingOptionalDependency>false</ignoreMissingOptionalDependency>
Expand All @@ -182,6 +184,7 @@ An advanced configuration can utilize the following parameters:
<reportOnlyFilename>false</reportOnlyFilename>
<skipXmlReport>false</skipXmlReport>
<skipHtmlReport>false</skipHtmlReport>
<skipMarkdownReport>false</skipMarkdownReport>
<skipDiffReport>false</skipDiffReport>
<includeModules>
<includeModule>.*incl.*</includeModule>
Expand Down Expand Up @@ -241,6 +244,7 @@ the &lt;dependency&gt; element. Through the &lt;parameter&gt; element you can pr
| excludeExclusively | true | false | Exclude only packages specified in the "excludes" parameter, include their sub-packages. |
| htmlStylesheet | true | n.a. | Path to an individual CSS stylesheet for the HTML report. |
| htmlTitle | true | n.a. | A title for the HTML report (optional). |
| markdownTitle | true | n.a. | A title for the Markdown report (optional). |
| skipPomModules | true | true | Setting this parameter to false (default: true) will not skip execution in modules with packaging type pom. |
| skip | true | false | Setting this parameter to true will skip execution of the plugin. |
| ignoreNonResolvableArtifacts | true | false | Set this to true in order to ignore artifacts that cannot be resolved, i.e. the build does not break in case a dependency cannot be resolved to a file. |
Expand All @@ -251,6 +255,7 @@ the &lt;dependency&gt; element. Through the &lt;parameter&gt; element you can pr
| postAnalysisScript | true | n.a. | A [Groovy](https://www.groovy-lang.org/) script that gets invoked after analysis is completed and before the output is written. This way it can be used to filter the output or break the build on specific conditions. It can be an absolute path or a relative path of a file within the classpath.|
| skipXmlReport | true | false | If set to true, no XML report will be generated. |
| skipHtmlReport | true | false | If set to true, no HTML report will be generated. |
| skipMarkdownReport | true | false | If set to true, no Markdown report will be generated. |
| skipDiffReport | true | false | If set to true, no diff report will be generated. |
| oldVersionPattern | true | n.a. | If &lt;oldVersion&gt; is not used, the old version compared against must match this regular expression. |
| includeModules | true | n.a. | List of regular expression that specify if an artifact should be excluded based on its artifact id. |
Expand Down
1 change: 1 addition & 0 deletions src/site/markdown/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Features
* All changes between annotations are compared, hence japicmp can be used to track annotation-based APIs like JAXB, JPA, JAX-RS, etc.
* A maven plugin is available that allows you to compare the current artifact version with some older version from the repository.
* The option `--semantic-versioning` tells you which part of the version you have to increment in order to follow [semantic versioning](http://semver.org/).
* The option `--markdown` generates output in [Markdown](https://www.markdownguide.org/) format.
* If a class is serializable, changes are evaluated regarding the [Java Object Serialization Specification](http://docs.oracle.com/javase/7/docs/platform/serialization/spec/serialTOC.html).
* Per default synthetic classes and class members (e.g. [bridge methods](https://docs.oracle.com/javase/tutorial/java/generics/bridgeMethods.html)) are hidden. They can be listed by using the option `--include-synthetic`.
* The maven plugin allows project-specific filtering and reports using a custom [Groovy](groovy-lang.org) script.
Expand Down

0 comments on commit 6feb875

Please sign in to comment.