ci: adds codecov to CI pipeline and coverage badge to README

[thawkin3]

I've added Codecov to the CI Pipeline so that the GitHub Actions workflow will run the unit tests with the coverage report and then pipe the results over to Codecov. I also added a code coverage badge to the README so that we can show off the awesome coverage.

I based my changes off of these two previous MRs in the focus-trap-react repo:

• Add codecov integration focus-trap-react#227
• docs: adds a code coverage badge to the README focus-trap-react#233

Closes #260

PR Checklist

Please leave this checklist in your PR.

• Source changes maintain stated browser compatibility.
• Issue being fixed is referenced.
• Unit test coverage added/updated.
• E2E test coverage added/updated.
• Typings added/updated.
• README updated (API changes, instructions, etc.).
• Changes to dependencies explained.
• Changeset added (run yarn changeset locally to add one, and follow the prompts).

[changeset-bot]

⚠️ No Changeset found

Latest commit: fd184e5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (master@c569855). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #261   +/-   ##
=========================================
  Coverage          ?   93.38%           
=========================================
  Files             ?        1           
  Lines             ?      257           
  Branches          ?       66           
=========================================
  Hits              ?      240           
  Misses            ?       16           
  Partials          ?        1           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c569855...fd184e5. Read the comment docs.

[maraisr]

Solid effort mate, thank you so much! Just one comment about the coverage commands.

[maraisr]

Rather than include this as a dep, we should just install this in the CI. There zero benefit to ever running this locally.

So can you please do a yarn global add codecov in the gh actions file, and just running that after the tests run. Similarity get rid of line 33 here.

[thawkin3]

Love it, thanks! I'll take care of that soon. On that note, we should probably do the same over in the focus-trap-react repo since it also has codecov listed as a dev dependency: https://github.com/focus-trap/focus-trap-react/blob/master/package.json#L77

I can make the same change over there once we get this MR approved.

[thawkin3]

After a few attempts, I think I finally have this working correctly. The CI pipeline passes anyway. 😅

These two issues helped me resolve the problem of the global yarn package not being installed properly or not being installed where it could be found:

• yarn global add doesn't install binaries properly yarnpkg/yarn#648
• yarn global installed binary package is not executable? actions/setup-node#85

[thawkin3]

FYI: This was the result after I removed the codecov package with yarn remove codecov. I checked for what packages are requiring @babel/plugin-proposal-nullish-coalescing-operator, and it's only @babel/preset-env which does in fact request @babel/plugin-proposal-nullish-coalescing-operator@^7.13.8.

So I believe what we see here is correct, and the fact that there were two versions of this package previously installed was unnecessary and that something had gotten out of sync with the lock file.

[thawkin3]

@maraisr I think this is ready for another round of review whenever you have a minute. Thanks!

[stefcameron]

👀

[stefcameron]

This looks good to me, thank you @thawkin3 ! I'll let @maraisr chime in before merging.

[maraisr]

Thanks for this one! 🦄

[thawkin3]

Thanks guys!