Skip to content

ci: Publish Checkstyle report to GitHub Pages#75

Merged
ebouchut merged 2 commits into
devfrom
ci-publish-checkstyle-report-to-pages
Jul 8, 2026
Merged

ci: Publish Checkstyle report to GitHub Pages#75
ebouchut merged 2 commits into
devfrom
ci-publish-checkstyle-report-to-pages

Conversation

@ebouchut

@ebouchut ebouchut commented Jul 8, 2026

Copy link
Copy Markdown
Owner

The rationale for this PR is to enable viewing the CheckStyle (lint) HTML report online when clicking the report badge in the README.md file.

This PR brings the following:

  • Publish Checkstyle HTML report to GitHub Pages on pushes to dev,
    • Deploys a site using upload-artifact and deploy-pages actions without commits
  • Keep artifact available for PR runs
    • online report updates on each merge to dev
  • Update docs and links to point to the GitHub Pages report, while documenting artifact and local paths for PR/offline use.

ebouchut added 2 commits July 8, 2026 09:51
On pushes to dev, the Lint workflow assembles a small site (the HTML report
under /checkstyle/ plus a root index redirecting to it) and deploys it with
the official upload-pages-artifact and deploy-pages actions. This flow
serves the artifact directly and creates no commits. PR runs keep producing
the downloadable artifact only; the online report refreshes on each merge
to dev.
The report badge chip and the documentation links now open the report
rendered on GitHub Pages (refreshed by the Lint workflow on each merge to
dev), replacing the nightly.link zip download. Keep the workflow-artifact
and local paths documented for PR runs and offline use.
@ebouchut ebouchut self-assigned this Jul 8, 2026
@ebouchut ebouchut added documentation Improvements or additions to documentation deployment enhancement ci Continuous Integration test labels Jul 8, 2026
@ebouchut ebouchut added this to the v0.7 - Doc Freeze milestone Jul 8, 2026
@codecov

codecov Bot commented Jul 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.58%. Comparing base (567281f) to head (f848fee).

Additional details and impacted files
@@            Coverage Diff            @@
##                dev      #75   +/-   ##
=========================================
  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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ebouchut ebouchut moved this to In Review in learn-dev-project Jul 8, 2026
@ebouchut ebouchut changed the title ci-publish-checkstyle-report-to-pages ci: Publish Checkstyle report to GitHub Pages Jul 8, 2026
@ebouchut ebouchut merged commit 0d61e37 into dev Jul 8, 2026
7 checks passed
@ebouchut ebouchut deleted the ci-publish-checkstyle-report-to-pages branch July 8, 2026 08:07
@github-project-automation github-project-automation Bot moved this from In Review to Done in learn-dev-project Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous Integration deployment documentation Improvements or additions to documentation enhancement test

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant