[MCHECKSTYLE-362] Add suppressionFileOptional configuration option to allow builds if file in suppressionsLocation is missing
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- build-system
Research direction
Start by tracing the Maven Checkstyle Plugin configuration for suppressionsLocation and the handling of Checkstyle's SuppressionFilter optional flag. Verify how an unresolved suppression file is currently supplied to Checkstyle, then define done as accepting suppressionFileOptional and allowing the build to continue when the configured file is missing.
Written by the indexing model from the issue text.
Description
Marcus Watkins opened MCHECKSTYLE-362 and commented
We use a parent pom containing our checkstyle configuration but have a few projects with generated code that we'd like to exclude from checkstyle rules. This means we have to copy the whole checkstyle configuration into these projects' poms with a suppressionsLocation because adding it to the parent would fail the builds in projects where that file is missing.
Checkstyle itself has an optional flag on SuppressionFilter that allows it to continue if the supplied file is missing.
We'd like to extend the Maven Checkstyle Plugin to have similar functionality by way of a suppressionFileOptional configuration option that would simply skip supplying the file value to checkstyle if the file fails to resolve.
If this sounds like something you would accept let us know and we'll whip it up and submit a PR.
1 votes, 3 watchers
- Dominant language
- Java
- Stars
- 98
- Forks
- 69
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 8
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/maven-checkstyle-plugin
-
maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
apache/maven-checkstyle-plugin#718 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 38/100
apache/maven-checkstyle-plugin#675 ·
Maintainers usually reply within 1 day
-
Update dependencies.May be free again A pull request for this issue was closed without being merged. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
apache/maven-checkstyle-plugin#664 ·
Maintainers usually reply within 1 day
-
DefaultCheckstyleExecutor should be a failure, not an errorPossibly taken @efegokdemir claimed this 33 days ago. Openbug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
apache/maven-checkstyle-plugin#656 · 1 comment ·
Maintainers usually reply within 1 day
-
Add ability to print warnings when `failOnViolation: true` and `violationSeverity: error`Possibly taken @efegokdemir claimed this 31 days ago. Openenhancement
Difficulty 3/5 1-2 days Newbie friendliness 50/100
apache/maven-checkstyle-plugin#648 · 5 comments ·
Maintainers usually reply within 1 day
All issues in apache/maven-checkstyle-plugin
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
linagora/twake-calendar-side-service#1218 · 1 comment ·
Maintainers usually reply within 1 day
-
[Bug] [Go] Ack returns nil when the server answers with a non-OK statusPossibly taken @leizhiyuan claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
apache/rocketmq-clients#1465 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
pdfium-drift
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Stirling-Tools/JPDFium#188 ·
Maintainers usually reply within 1 day