Run Codecov Workflow only when PR is ready

[jiji14]

Why Change the Workflow?

Sending a coverage report to Codecov with GitHub Action without a token encounters a rate limit issue. For more details, please refer to the comments on issue #1085.

In the current flow, the Codecov workflow runs whenever we push code to PR. To address the rate limit issue, we have decided to run the workflow only when we are ready for review.

When PR is draft

[codecov]

Codecov Report

Merging #1114 (1901f4c) into service_rewrite_2023 (1006165) will not change coverage.
Report is 43 commits behind head on service_rewrite_2023.
The diff coverage is n/a.

Additional details and impacted files

@@                  Coverage Diff                  @@
##           service_rewrite_2023    #1114   +/-   ##
=====================================================
  Coverage                 58.80%   58.80%           
=====================================================
  Files                        26       26           
  Lines                      1420     1420           
  Branches                    320      320           
=====================================================
  Hits                        835      835           
  Misses                      585      585           

Flag	Coverage Δ
unit	58.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[jiji14]

@JGreenlee
Jest runs on both the osx-serve-install and codecov workflows. I think it's enough to execute Jest when the PR is ready, specifically in the code coverage workflow. What are your thoughts? If you agree, I will delete Jest execution in osx-serve-install

[JGreenlee]

@jiji14 I think as long as the expectation is for contributors to run the tests locally before they mark a PR as ready, this makes sense.

The plan was to extract Jest testing out of the osx-serve-install workflow at some point anyway

[jiji14]

@JGreenlee
I believe most contributors run the tests locally, but we can't guarantee that every contributor does so. I guess the safest approach is to keep Jest in osx-serve-install workflow

[JGreenlee]

If a contributor forgets to run tests locally, they would mark it ready for review causing the workflow to run, and checks might fail.

In this scenario, do they have a way to re-trigger the workflow after making fixes? Can they mark it ready for review again?
If so, I think it's fine to remove Jest from the osx-serve-install workflow.

[jiji14]

@JGreenlee

I've just verified that Codecov is executed whenever the PR status transitions from Draft to Ready to Review in this workflow.

In your scenario,

1. If a contributor forgets to run tests and the initial attempt fails,
2. They can switch the PR to draft status to address the issues.
3. When the necessary fixes are made, they can mark the PR as Ready to Review, triggering Codecov.

Does this clarify the process?

[JGreenlee]

Does this clarify the process?

Yes it does!

If so, I think it's fine to remove Jest from the osx-serve-install workflow.

Then I think we can remove Jest from the osx-serve-install workflow to avoid running the tests twice.

[JGreenlee]

LGTM!