slachiewicz opened a new pull request, #752:
URL: https://github.com/apache/maven-checkstyle-plugin/pull/752
Refreshes the plugin site and README ahead of 3.6.1, so a first-time user
finds the goals, the floors and working examples.
Several examples did not work as written, and the fixes were tested against
3.6.1-SNAPSHOT:
- Custom checks: the class extended `Check`, which Checkstyle 6 removed; the
POM used `checkstyle:checkstyle` at the plugin version; and the package names
file sat next to the class as `packagenames.xml`, which Checkstyle never reads.
It now uses `AbstractCheck` and `checkstyle_packages.xml` at the classpath
root, and a short module name resolves.
- Property expansion: the rendered regex showed `$\{projectname\}` with
backslashes; copied as is, it never matched.
- Suppressions filter: the plugin applies the file itself, so the
configuration needs no `SuppressionFilter` module; `suppressionsFileExpression`
was set to its default.
- Usage: `check` was configured with `linkXRef`, which only the report goals
have, and the goal was spelled `checkstyle::check`.
- Inline configuration: the different-header example pinned Checkstyle 8.15
with the header the plugin already writes. The 1.3 default works with
Checkstyle 9.3, 10.26.1 and 14.4.0.
The history page gains 3.3.1 to 3.6.0, and its Checkstyle release-note links
point to the pages that now hold each version (the old URLs redirect without
the fragment). The runtime upgrade page lists the Java floor of each Checkstyle
line. Anchors from the published 3.6.0 site that master's heading rewrite
dropped are restored with `<a id>` tags, including the FAQ anchor with raw
colons. The README replaces the generic contributing template and Jenkins
badges.
Verified: `mvn site -Preporting` and every live 3.6.0 anchor resolve in
`target/site`; the documented goals and examples were run against a scratch
project.
---
To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](https://www.apache.org/licenses/LICENSE-2.0)
check one of the following:
- [x] I hereby declare this contribution to be licensed under the [Apache
License Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0)
- [x] I hereby declare that I have filed an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]