Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated coverage workflow to satisfy node20 requirements #37

Merged
merged 2 commits into from
Apr 17, 2024

Conversation

jesuyedavid
Copy link
Contributor

@jesuyedavid jesuyedavid commented Apr 15, 2024

Updated .github/workflows/coverage.yml to use new workflow action versions so as to get rid of previous node16 deprecation warnings after workflow builds.

Some things to note:

  1. We bumped actions/checkout, actions/setup-node, actions/upload-artifact, actions/download-artifact to their respective versions 4.

  2. Updated coverallsapp/github-action to use version 2, which now requires us to specify a coverage/lcov.info in the build action because according to Coveralls' release notes here, v2 automatically tries to find all supported coverage files and then combine their data. coverage/lcov.info was the previous default file path for the coverage file used by node-coveralls and we're now manually specifying the path so there's no behavior change from from the above update.

  3. Because we're updating the upload action to v4, any repo that downloads the coverage (which seems to just be search-ui-react) will need to upgrade their download action to v4

J=WAT-3813

Tested by pointing some libraries that depend on this workflow to this workflow branch and seeing that deprecation warnings have disappeared.

@jesuyedavid jesuyedavid requested a review from a team as a code owner April 15, 2024 16:43
Copy link

@vijay267 vijay267 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll defer to Nidhi on the actual changes, but noticed there's a typo in the commit message title in case you can change it. Thanks.

@jesuyedavid
Copy link
Contributor Author

I'll defer to Nidhi on the actual changes, but noticed there's a typo in the commit message title in case you can change it. Thanks.

sorry, this is not ready for actual review. we are testing things out and debugging code coverage percentage reduction. sorry, is should i have written it in the description somewhere.

@nmanu1
Copy link
Contributor

nmanu1 commented Apr 16, 2024

sorry, this is not ready for actual review. we are testing things out and debugging code coverage percentage reduction. sorry, is should i have written it in the description somewhere.

fyi, you can add a wip label to the PR or change it to a draft if you want to indicate that it's not ready for review

@jesuyedavid jesuyedavid marked this pull request as draft April 16, 2024 19:36
@jesuyedavid jesuyedavid requested a review from nmanu1 April 16, 2024 21:35
@jesuyedavid jesuyedavid changed the title udpated coverage workflow for node20 Updated coverage workflow to satisfy node20 requirements Apr 16, 2024
@jesuyedavid jesuyedavid marked this pull request as ready for review April 16, 2024 21:39
Copy link
Contributor

@nmanu1 nmanu1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: you mentioned it in the PR description, but can you give more detail about all the relevant breaking changes from updating coverallsapp/github-action from v1 to v2? and can you add the JIRA item and testing details as well?

@jesuyedavid jesuyedavid merged commit a4e6207 into main Apr 17, 2024
1 check passed
@jesuyedavid jesuyedavid deleted the dev/update_coverage_reusable_workflow branch April 17, 2024 19:25
@jesuyedavid jesuyedavid mentioned this pull request May 1, 2024
jesuyedavid added a commit that referenced this pull request May 1, 2024
Remove Node 16 deprecation warnings (#37, #38)
jesuyedavid added a commit to yext/search-ui-react that referenced this pull request May 14, 2024
### Changes

1. In accordance with [3] of [this PR](yext/slapshot-reusable-workflows#37), we updated `coverage.yml` to use `actions/download-artifact@v4`. 

2. `main.yml`, and `update-snapshots.yml` actions of this repo were also updated to stop the node 16 deprecation warnings

3. Bumped versions for [peter-evans/create-or-update-comment](https://github.com/peter-evans/create-or-update-comment/releases) to v4, [peter-evans/find-comment](https://github.com/peter-evans/find-comment/releases) to v3, and [actions/github-script](https://github.com/actions/github-script/releases?page=3) to v7.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants