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

Codecov work #2888

Merged

Conversation

VanshikaSabharwal
Copy link

@VanshikaSabharwal VanshikaSabharwal commented Jan 23, 2025

What kind of change does this PR introduce?

bugfix

Issue Number:

Fixes #2854
Previous Merge Related to this issue #2877

Snapshots/Videos:
image
image

If relevant, did you update the documentation?

Summary
I have updated the push-deploy-website.yml file to send Codecov data to the Codecov website after a merge.

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

  • I have reviewed and addressed all critical issues flagged by CodeRabbit AI
  • I have implemented or provided justification for each non-critical suggestion
  • I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

  • I have written tests for all new changes/features
  • I have verified that test coverage meets or exceeds 95%
  • I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Yes

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores
    • Added a new step to install pnpm in the GitHub Actions workflow for automated testing and coverage reporting on the develop-postgres branch.
    • Configured caching options for improved dependency management.
    • Continuous integration remains in place to run tests and upload coverage metrics.

VanshikaSabharwal and others added 30 commits January 19, 2025 23:50
Copy link

coderabbitai bot commented Jan 23, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow file for the develop-postgres branch by adding a new step to set up pnpm before the existing steps that install dependencies and run tests. This new step utilizes the pnpm/action-setup@v4 action, which includes caching options for pnpm.

Changes

File Change Summary
.github/workflows/push.yml Added a new step to set up pnpm using pnpm/action-setup@v4 with caching options before existing dependency installation and test steps.

Assessment against linked issues

Objective Addressed Explanation
Restore CodeCov GitHub Action to develop-postgres branch [#2854]
Enable CodeCov statistics reporting

Possibly related PRs

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

  • palisadoes

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d62a16 and 6ffd1e2.

📒 Files selected for processing (1)
  • .github/workflows/push.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (1)
.github/workflows/push.yml (1)

17-23: 🛠️ Refactor suggestion

Add cache dependency paths for efficient caching.

While the pnpm setup is correctly using the official action, the cache configuration is incomplete. Add the dependency paths to ensure efficient caching.

       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
           version: 8
           cache: pnpm
+          cache-dependency-path: |
+            pnpm-lock.yaml
+            package.json

Likely invalid or redundant comment.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🔭 Outside diff range comments (2)
.github/workflows/push.yml (2)

Line range hint 23-34: Consolidate coverage upload steps to avoid redundancy.

The workflow appears to upload coverage data twice:

  1. During the test run (implicitly through environment variable)
  2. Using the codecov action

This redundancy might cause issues with coverage reporting.

Consolidate the coverage upload by removing the CODECOV_TOKEN from the test step and relying solely on the codecov action:

       - name: Run Tests and Upload Coverage to Codecov
         run: |
           pnpm install --frozen-lockfile
           pnpm run test
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
🧰 Tools
🪛 actionlint (1.7.4)

15-15: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


Line range hint 31-34: Consider adding fail_ci_if_error flag.

To ensure CI fails if coverage upload fails, which helps catch coverage reporting issues early.

Add the flag to the codecov action:

       - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
           files: ./coverage/lcov.info
+          fail_ci_if_error: true
🧰 Tools
🪛 actionlint (1.7.4)

15-15: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f04c38e and 6358a0b.

📒 Files selected for processing (1)
  • .github/workflows/push.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)

.github/workflows/push.yml Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop-postgres@f04c38e). Learn more about missing BASE report.

Additional details and impacted files
@@                 Coverage Diff                 @@
##             develop-postgres    #2888   +/-   ##
===================================================
  Coverage                    ?   39.85%           
===================================================
  Files                       ?      453           
  Lines                       ?    33203           
  Branches                    ?      385           
===================================================
  Hits                        ?    13234           
  Misses                      ?    19969           
  Partials                    ?        0           

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 23, 2025
Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

Use npm to install pnpm

.github/workflows/push.yml Outdated Show resolved Hide resolved
Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 23, 2025
Copy link
Contributor

@palisadoes palisadoes left a comment

Choose a reason for hiding this comment

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

  1. I discovered pnpm has its own github action for setup. Please use that instead
  2. Look at pull-request.yml
    • pnpm/action-setup@v4

@@ -14,6 +14,10 @@ jobs:
- name: Checkout code
uses: actions/checkout@v3

# Install pnpm
- name: Install pnpm
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. I discovered pnpm has its own github action for setup. Please use that instead
  2. Look at pull-request.yml
    • pnpm/action-setup@v4

Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2349688 and 5d62a16.

📒 Files selected for processing (1)
  • .github/workflows/push.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (1)
.github/workflows/push.yml (1)

Line range hint 27-41: LGTM! Codecov integration is properly configured.

The Codecov setup follows best practices:

  • Uses environment variables for secure token handling
  • Enables verbose output for better debugging
  • Specifies the coverage file path explicitly
🧰 Tools
🪛 actionlint (1.7.4)

15-15: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

Comment on lines 17 to 25
# Setup pnpm
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
docs/package.json

Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Consider adding pnpm version constraint.

While the setup uses the official pnpm action as recommended, it's good practice to specify a version to ensure consistent builds.

       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
+          version: 8
           cache: pnpm
           cache-dependency-path: |
             docs/pnpm-lock.yaml
             docs/package.json
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Setup pnpm
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
docs/package.json
# Setup pnpm
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 8
cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
docs/package.json

Comment on lines 17 to 24
# Setup pnpm
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
docs/package.json
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Cache configuration is incorrect and needs to include root dependencies

The current cache only includes docs directory dependencies, but the workflow runs pnpm install and tests in the root directory. Update the cache configuration to:

cache-dependency-path: |
  pnpm-lock.yaml
  package.json
🔗 Analysis chain

Verify the cache dependency paths.

The cache configuration appears to be looking for pnpm files only in the docs directory. This might not be correct if your project's main dependencies are in the root directory.

Let's verify the correct location of the pnpm files:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for pnpm files in both root and docs directory
echo "Checking pnpm files location..."
fd -t f "pnpm-lock.yaml|package.json" -d 2

Length of output: 183


Script:

#!/bin/bash
# Examine the complete workflow file
cat .github/workflows/push.yml

Length of output: 1030

uses: pnpm/action-setup@v4
with:
cache: pnpm
cache-dependency-path: |
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove. This was specific to deploying the website

with:
cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove. This was specific to deploying the website

cache: pnpm
cache-dependency-path: |
docs/pnpm-lock.yaml
docs/package.json
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove. This was specific to deploying the website

.github/workflows/push.yml Show resolved Hide resolved
.github/workflows/push.yml Show resolved Hide resolved
Copy link

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@VanshikaSabharwal
Copy link
Author

@palisadoes are you asking me to remove this
# Setup pnpm - name: Setup pnpm uses: pnpm/action-setup@v4 with: version: 8 cache: pnpm

@palisadoes palisadoes merged commit ed57c24 into PalisadoesFoundation:develop-postgres Jan 23, 2025
16 of 18 checks passed
This was referenced Jan 24, 2025
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.

2 participants