CI: store merged coverage as artifact

[saiaunghlyanhtet]

Integrate Code Coverage Reporting in CI Pipeline

Summary:

This pull request integrates code coverage reporting into the existing CI pipeline. The following updates have been made to the GitHub Actions workflow to ensure that code coverage is tracked and uploaded to the Coveralls service.

Changes:

• Added Code Coverage Steps:

  • Introduced coverage generation after running tests in the CI pipeline.
  • Integrated the Coveralls reporting tool to upload the coverage data.
  • Modified the test job in the CI workflow to include coverage steps.

• Test Coverage Reporting:

  • Coverage is generated for each test run and uploaded as an artifact.
  • This allows the team to track the test coverage on each pull request.

Impact:

• Continuous monitoring of code coverage ensures that new code contributions maintain high-quality tests.
• Developers can review coverage metrics and ensure new features are adequately tested.

Related Issues:

• Resolves issue: CI: store merged coverage as an artifact #1256 (if any related issues exist).

[ti-mo]

Hi, please undo all the style changes and limit your PR to only adding the extra build step.

[saiaunghlyanhtet]

Hi, please undo all the style changes and limit your PR to only adding the extra build step.

Sorry, I think it's because of my editor. Made changes as requested.

[ti-mo]

@saiaunghlyanhtet Looks like none of our CI jobs currently generate coverage reports, so you'll have to enable those first. run-tests.sh used to do that, but that's now gone.

[saiaunghlyanhtet]

@saiaunghlyanhtet Looks like none of our CI jobs currently generate coverage reports, so you'll have to enable those first. run-tests.sh used to do that, but that's now gone.

Thank you. I will fix it.

[saiaunghlyanhtet]

@ti-mo I have made changes. Can you review it again, please?

[ti-mo]

@saiaunghlyanhtet Why do coverage reports need to go into a separate directory? You're still not merging the output of the matrix jobs.

[saiaunghlyanhtet]

@saiaunghlyanhtet Why do coverage reports need to go into a separate directory? You're still not merging the output of the matrix jobs.

@ti-mo
First, I thought I needed it, but now I am uploading them into action artifacts as default and downloading them before merging in merge step. This time I think all coverage reports will be included, including outputs for matrix jobs.

[ti-mo]

go tool covdata doesn't work on the plaintext files generated with go test -coverprofile=. It only works with the new binary format, which is currently a bit annoying to produce with go test, see golang/go#66225 (comment). The cover directory needs to exist for this to work.

Documentation:
https://go.dev/doc/build-cover
https://go.dev/blog/integration-test-coverage

Please make sure your code (the commands executed, at least) work before pushing up your changes. It looks like you've been pushing commits blindly so far, which is not very respectful of a reviewer's time.

If you want to experiment with GHA workflows offline, take a look at https://github.com/nektos/act.