document coverage workflow

[yaahc]

Motivation

I setup source based coverage reports for zebra a while ago but they're not very obvious so I'm documenting how to access them before I leave so they don't get forgotten.

Solution

The code in this pull request has:

• Documentation Comments

Review

Related Issues

Follow Up Work

[teor2345]

I also see a failed attempt to upload to codecov.io in CI, due to missing API(?) tokens.

Should we disable that step for now?

==> Uploading reports
    url: https://codecov.io
    query: branch=coverage-no-incremental&commit=416cdabe60dc015db15c6a9ecd228a88e411d20f&build=666374397&build_url=http%3A%2F%2Fgithub.com%2FZcashFoundation%2Fzebra%2Factions%2Fruns%2F666374397&name=&tag=&slug=ZcashFoundation%2Fzebra&service=github-actions&flags=&pr=1923&job=CI&cmd_args=n,F,Q,C
->  Pinging Codecov
https://codecov.io/upload/v4?package=github-action-20210309-2b87ace&token=secret&branch=coverage-no-incremental&commit=416cdabe60dc015db15c6a9ecd228a88e411d20f&build=666374397&build_url=http%3A%2F%2Fgithub.com%2FZcashFoundation%2Fzebra%2Factions%2Fruns%2F666374397&name=&tag=&slug=ZcashFoundation%2Fzebra&service=github-actions&flags=&pr=1923&job=CI&cmd_args=n,F,Q,C
{'detail': ErrorDetail(string='Unable to locate build via Github Actions API. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}
404
==> Uploading to Codecov
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100 3218k  100   171  100 3218k   1075  19.7M --:--:-- --:--:-- --:--:-- 19.7M
    {'detail': ErrorDetail(string='Unable to locate build via Github Actions API. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}

[yaahc]

Should we disable that step for now?

sounds good. I just can't get over how hilarious it is that the feature broke in the PR I was documenting it from, even though its been working for months and this PR doesn't change it at all. What a world.

[dconnolly]

I also see a failed attempt to upload to codecov.io in CI, due to missing API(?) tokens.

Should we disable that step for now?

==> Uploading reports
    url: https://codecov.io
    query: branch=coverage-no-incremental&commit=416cdabe60dc015db15c6a9ecd228a88e411d20f&build=666374397&build_url=http%3A%2F%2Fgithub.com%2FZcashFoundation%2Fzebra%2Factions%2Fruns%2F666374397&name=&tag=&slug=ZcashFoundation%2Fzebra&service=github-actions&flags=&pr=1923&job=CI&cmd_args=n,F,Q,C
->  Pinging Codecov
https://codecov.io/upload/v4?package=github-action-20210309-2b87ace&token=secret&branch=coverage-no-incremental&commit=416cdabe60dc015db15c6a9ecd228a88e411d20f&build=666374397&build_url=http%3A%2F%2Fgithub.com%2FZcashFoundation%2Fzebra%2Factions%2Fruns%2F666374397&name=&tag=&slug=ZcashFoundation%2Fzebra&service=github-actions&flags=&pr=1923&job=CI&cmd_args=n,F,Q,C
{'detail': ErrorDetail(string='Unable to locate build via Github Actions API. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}
404
==> Uploading to Codecov
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100 3218k  100   171  100 3218k   1075  19.7M --:--:-- --:--:-- --:--:-- 19.7M
    {'detail': ErrorDetail(string='Unable to locate build via Github Actions API. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}

The latest coverage builds with CARGO_INCREMENTAL: 0 are not showing upload errors so I think this was a spurious error.

We should rebase this branch to pick up that coverage.yml change.