[Enhancement] Enhance Code Quality Checking in CI

[alaahong]

Search before asking

• I searched in the issues and found nothing similar.

Motivation

As a developer,
I wanna involve code quality checking into current CI pipeline,
So create this issue for tracking.

Solution

Plan to involve below stack one by one:

1. Fix all test failure in project level
   [DONE] feat: enable all verification in ci #390 fix: fix all cases #372 fix: Fix style test #371 test: Add web input stream test #361 test: Add comment test #360 fix: fix poi write #348 fix: fix data format #341 fix: complex header test #334 fix: fix repeat cases #315 fix: issue in FileTemp and Poi3 #298 Feature/fix image write issue #297 fix: all files with zhuangjiaju's local path #286 fix: unclose resource in temp write #285 fix: maven properties and module exception for reflection #284 fix: failure unit test #283
2. Add Jacoco into maven test phase, which is used to generate the code coverage
   [DONE] feat: add code coverage report in ci #422
3. Add Codecov into CI, which is used to track the project and commit coverage status
   [TODO] As a healthy project, the coverage should keep moving
4. [Optional] Add Unit Test Results within PR CI
   [DONE] GitHub Action to Publish Test Results, it's friendly for developer to mention the failure case
   feat: Add Unit Test Results within PR CI #424
5. [Optional] Integration with Sonar
   [TODO] As Fastexcel is based on POI, we often meet several security warning and finding
6. [Optional] Nightly Build
   [DONE] As full test will take hours in CI, current CI only perform the core test, so how about to schedule the full test in nightly build?
   feat: add nightly build for fully test #437
7. Add CI Check for Markdown files as document integration
   chore: add markdown lint check for markdown files on push and pull request #497

Alternatives

No response

Anything else?

Please feel free to suggest on the specific solution and more actions.

Are you willing to submit a PR?

• I'm willing to submit a PR!

[alaahong]

For the code coverage presenting, is that nice to have?

If yes, as jacoco had been involved, both Codecov and Sonar can provide more functions on PR and Comment
e.g. sample PR alaahong/open_automation_quiz#40

Codecov

Sonar Cloud

And meanwhile, for the badges in project reamdme

And meanwhile, as full UT will trigger hours, so current ci only perform core ut. So, how about to trigger the nightly build for full ut?

@delei @psxjoy
Please suggest

[delei]

LGTM!
Although I don't have much experience using GitHub Actions, but I think this is a necessary task. Based on the sample content, I think it's great.

[alaahong]

LGTM! Although I don't have much experience using GitHub Actions, but I think this is a necessary task. Based on the sample content, I think it's great.

Thanks for your feedback, just wonder if so many comments with actions? or any duplicated on codecov and sonar together...

[psxjoy]

Great suggestion! Indeed, many projects use Codecov, and I've also seen some projects start migrating to Sonar Cloud. I think any plugin is reasonable, so just choose the one that's easiest to integrate with :)

[delei]

IMO,It should not be necessary to check every PR, but rather a workflow that runs on a schedule.

[alaahong]

Great suggestion! Indeed, many projects use Codecov, and I've also seen some projects start migrating to Sonar Cloud. I think any plugin is reasonable, so just choose the one that's easiest to integrate with :)

As discussed, I might trigger the SonarCloud integration firstly as it already including coverage and quality gate.
Please notice the project owner to approve previous sonar request or grant as member.