ci: Add a link to CheckStyle (lint) report#74
Merged
Conversation
The checkstyle-report artifact contained only the raw XML result, while checkstyle:checkstyle also produces a browsable HTML report under target/reports/ with its assets. Ship both in the artifact, like the coverage artifact does for the JaCoCo HTML site.
Fill the Code Style and Formatting stub in CONTRIBUTING.md: Java 4-space indentation checked by Checkstyle against config/checkstyle/checkstyle.xml (advisory, see ADR-0012 restating ADR-0011), HTML/CSS 2-space indentation, and a Checkstyle Report subsection giving the local paths (target/reports/checkstyle.html, target/checkstyle-result.xml) and the CI checkstyle-report artifact, mirroring the coverage subsection. Reference the report from the README documentation list.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #74 +/- ##
=========================================
Coverage 75.58% 75.58%
Complexity 22 22
=========================================
Files 8 8
Lines 86 86
Branches 5 5
=========================================
Hits 65 65
Misses 16 16
Partials 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
A Markdown image can carry only one link, so a single badge cannot point to both the Lint workflow and the report. Render a badge pair instead: the existing lint status badge (linking to the workflow runs) immediately followed by a compact report chip linking to the latest checkstyle-report artifact through nightly.link, which serves a stable URL for the newest artifact of a workflow on a branch without requiring a GitHub session. The zip contains reports/checkstyle.html. Document the same direct link in the Code quality entry of the documentation list.
ebouchut
added
documentation
ebouchut
changed the title
ebouchut
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make the CI Checkstyle report easy to find, mirroring the coverage links.
reports/checkstyle.html) alongside the raw XML in thecheckstyle-reportartifact.Code Style and Formattingstub inCONTRIBUTING.md(Java 4-space + project Checkstyle ruleset, HTML/CSS 2-space, advisory per ADR-0012) with aCheckstyle Reportsubsection (local paths + CI artifact); adds aCode quality reportentry to the README documentation list.reportbadge toREADME.md. When clicked, it downloads the latest CheckStyle report (in HTML format).It uses nightly.link, a free online artifact proxy service.