Add GitHub Actions Workflow for Build and Test #717

niStee · 2024-02-25T00:18:47Z

Standards checklist:

The PR title is descriptive.
I have read CONTRIBUTING.md
The code compiles (cargo build)
The code passes rustfmt (cargo fmt)
The code passes clippy (cargo clippy)
The code passes tests (cargo test)
Optional: I have tested the code myself

For new steps

Optional: Topgrade skips this step where needed
Optional: The --dry-run option works with this step
Optional: The --yes option works with this step if it is supported by
the underlying command

If you developed a feature or a bug fix for someone else and you do not have the
means to test it, please tag this person here.

*.profraw files are generated by LLVM's Clang compiler when using the -fprofile-instr-generate option for Profile Guided Optimization. These files contain raw profiling data and should not be version controlled."

The TryFrom trait was being imported explicitly in src\steps\os\windows.rs, even though it's already part of the Rust prelude and automatically imported into every Rust program. This was causing a compiler warning. This commit comments out the redundant import to resolve the warning.

This commit adds a new GitHub Actions workflow for building and testing the Rust project across multiple operating systems (Ubuntu, Windows, macOS) and Rust versions (stable, beta, nightly). It also includes caching for dependencies and build artifacts, and uploads code coverage reports to Codecov.

This commit updates the version of the Codecov GitHub Action used to upload coverage reports from v4 to v4.0.1. It also adds a token from the repository secrets to authenticate the upload. This ensures secure and authorized communication with the Codecov service.

The grcov command was previously prefixed with './', which caused an error because grcov was not found in the current directory. This commit removes the './' prefix to call grcov from the global path, where it is installed."

This commit modifies the 'build-and-test.yml' GitHub Actions workflow to ensure it works correctly across different operating systems (Ubuntu, Windows, MacOS). The RUSTFLAGS environment variable is now set in a cross-platform compatible way. The workflow will run the build and test process on every pull request and push to the main branch, generate a coverage report, and upload it to Codecov.

… and test' workflow

…es for code coverage"

Change the trigger of the 'Test with Code Coverage' workflow to run when the 'build-and-test' workflow is completed. This ensures that code coverage is only calculated after successful build and test runs.

…to main branch

codecov · 2024-02-25T00:22:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (main@eea952f). Click here to learn what that means.

Additional details and impacted files

@@          Coverage Diff           @@
##             main    #717   +/-   ##
======================================
  Coverage        ?   5.64%           
======================================
  Files           ?      37           
  Lines           ?   11538           
  Branches        ?       0           
======================================
  Hits            ?     651           
  Misses          ?   10887           
  Partials        ?       0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

niStee · 2024-02-25T01:01:46Z

I plan to write some unit tests to increase the code coverage. This is just the first step to actually see what is already covered.
I think I prefer LLVM-tools over cargo2junit.
But I am trying to update the former code coverage workflow as well.

src/steps/os/windows.rs

SteveLauC · 2024-02-25T01:34:27Z

But I am trying to update the former code coverage workflow as well.

For these 2 workflows for code coverage, are they duplicates? I see both are using the grocv tool.

I think I prefer LLVM-tools over cargo2junit.

I don't have a preference over these 2 tools, it will be ok as long as it works.

I plan to write some unit tests to increase the code coverage. This is just the first step to actually see what is already covered.

Actually, even though we already had a workflow for tests coverage, it has been disabled manually since it failed every pull request, but I am willing to enable it if we can make it work:)

niStee · 2024-02-25T01:40:40Z

I plan to write some unit tests to increase the code coverage. This is just the first step to actually see what is already covered.

Actually, even though we already had a workflow for tests coverage, it has been disabled manually since it failed every pull requests, but I am willing to enable it if we can make it work:)

Nothing like a solid 5% code coverage to ensure our code is bulletproof! 🙃

.github/workflows/build-and-test.yml

.github/workflows/code-coverage.yml

Co-authored-by: SteveLauC <stevelauc@outlook.com>

SteveLauC

Thanks!

SteveLauC · 2024-02-25T02:36:43Z

I forgot that beta toolchain thing, anyway, let's do it in another PR:D

* "Add *.profraw files to .gitignore *.profraw files are generated by LLVM's Clang compiler when using the -fprofile-instr-generate option for Profile Guided Optimization. These files contain raw profiling data and should not be version controlled." * Remove redundant import of TryFrom trait The TryFrom trait was being imported explicitly in src\steps\os\windows.rs, even though it's already part of the Rust prelude and automatically imported into every Rust program. This was causing a compiler warning. This commit comments out the redundant import to resolve the warning. * Add GitHub Actions workflow for Rust build and test This commit adds a new GitHub Actions workflow for building and testing the Rust project across multiple operating systems (Ubuntu, Windows, macOS) and Rust versions (stable, beta, nightly). It also includes caching for dependencies and build artifacts, and uploads code coverage reports to Codecov. * Update Codecov action and add token for coverage report upload This commit updates the version of the Codecov GitHub Action used to upload coverage reports from v4 to v4.0.1. It also adds a token from the repository secrets to authenticate the upload. This ensures secure and authorized communication with the Codecov service. * "Fix misuse of --jobs flag in cargo test command" * "Fix grcov command in GitHub Actions workflow The grcov command was previously prefixed with './', which caused an error because grcov was not found in the current directory. This commit removes the './' prefix to call grcov from the global path, where it is installed." * Update GitHub Actions workflow for cross-platform compatibility This commit modifies the 'build-and-test.yml' GitHub Actions workflow to ensure it works correctly across different operating systems (Ubuntu, Windows, MacOS). The RUSTFLAGS environment variable is now set in a cross-platform compatible way. The workflow will run the build and test process on every pull request and push to the main branch, generate a coverage report, and upload it to Codecov. * Changed workflow trigger event to 'workflow_run' completion of 'Build and test' workflow * "Updated GitHub Actions workflow to correctly set environment variables for code coverage" * Renamed build and test workflow * Update GitHub Actions workflow trigger Change the trigger of the 'Test with Code Coverage' workflow to run when the 'build-and-test' workflow is completed. This ensures that code coverage is only calculated after successful build and test runs. * Update workflow_run trigger in code-coverage.yml * Fix CODECOV_TOKEN in code-coverage.yml workflow * Update code-coverage workflow to trigger on pull requests and pushes to main branch * Update .gitignore file to exclude LLVM profiling output * Add empty line at the end * Remove unused import in windows.rs * Update .github/workflows/build-and-test.yml Co-authored-by: SteveLauC <stevelauc@outlook.com> * Update .github/workflows/build-and-test.yml Co-authored-by: SteveLauC <stevelauc@outlook.com> * Remove code coverage workflow --------- Co-authored-by: SteveLauC <stevelauc@outlook.com>

niStee added 16 commits February 24, 2024 16:16

"Add *.profraw files to .gitignore

aa2c376

*.profraw files are generated by LLVM's Clang compiler when using the -fprofile-instr-generate option for Profile Guided Optimization. These files contain raw profiling data and should not be version controlled."

"Fix misuse of --jobs flag in cargo test command"

5e93ccb

"Fix grcov command in GitHub Actions workflow

7152ac5

The grcov command was previously prefixed with './', which caused an error because grcov was not found in the current directory. This commit removes the './' prefix to call grcov from the global path, where it is installed."

Changed workflow trigger event to 'workflow_run' completion of 'Build…

995c1ed

… and test' workflow

"Updated GitHub Actions workflow to correctly set environment variabl…

dd378ef

…es for code coverage"

Renamed build and test workflow

6dc20c1

Update GitHub Actions workflow trigger

01751c9

Change the trigger of the 'Test with Code Coverage' workflow to run when the 'build-and-test' workflow is completed. This ensures that code coverage is only calculated after successful build and test runs.

Update workflow_run trigger in code-coverage.yml

ad6a370

Fix CODECOV_TOKEN in code-coverage.yml workflow

da92f7c

Update code-coverage workflow to trigger on pull requests and pushes …

b4e0c34

…to main branch

Update .gitignore file to exclude LLVM profiling output

3be131a

Add empty line at the end

4c2e509

SteveLauC reviewed Feb 25, 2024

View reviewed changes

src/steps/os/windows.rs Outdated Show resolved Hide resolved

Remove unused import in windows.rs

6ea5071

SteveLauC requested changes Feb 25, 2024

View reviewed changes

niStee and others added 3 commits February 25, 2024 03:06

Update .github/workflows/build-and-test.yml

a879ef8

Co-authored-by: SteveLauC <stevelauc@outlook.com>

Update .github/workflows/build-and-test.yml

1b0e539

Co-authored-by: SteveLauC <stevelauc@outlook.com>

Remove code coverage workflow

6386305

SteveLauC approved these changes Feb 25, 2024

View reviewed changes

SteveLauC merged commit 0e30e05 into topgrade-rs:main Feb 25, 2024
22 checks passed

niStee deleted the story/cargoTests branch February 25, 2024 02:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GitHub Actions Workflow for Build and Test #717

Add GitHub Actions Workflow for Build and Test #717

niStee commented Feb 25, 2024

codecov bot commented Feb 25, 2024 •

edited

Loading

niStee commented Feb 25, 2024

SteveLauC commented Feb 25, 2024 •

edited

Loading

niStee commented Feb 25, 2024 •

edited

Loading

SteveLauC left a comment

SteveLauC commented Feb 25, 2024

Add GitHub Actions Workflow for Build and Test #717

Add GitHub Actions Workflow for Build and Test #717

Conversation

niStee commented Feb 25, 2024

Standards checklist:

For new steps

codecov bot commented Feb 25, 2024 • edited Loading

Codecov Report

niStee commented Feb 25, 2024

SteveLauC commented Feb 25, 2024 • edited Loading

niStee commented Feb 25, 2024 • edited Loading

SteveLauC left a comment

Choose a reason for hiding this comment

SteveLauC commented Feb 25, 2024

codecov bot commented Feb 25, 2024 •

edited

Loading

SteveLauC commented Feb 25, 2024 •

edited

Loading

niStee commented Feb 25, 2024 •

edited

Loading