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

chore: Update CI configuration to enable test coverage and add covera… #1019

Conversation

snobbee
Copy link
Contributor

@snobbee snobbee commented Dec 12, 2024

Relates to:

N/A - CI test improvement

Risks

Low - This change only affects CI test workflow and has no impact on production code.

Background

What does this PR do?

Adds the coverage directory to .gitignore to prevent test coverage reports from being committed to the repository. This is a best practice as coverage reports are generated artifacts that should not be version controlled.

Updated the CI workflow to generate coverage files to upload to codecov.

What kind of change is this?

Improvements (misc. changes to existing features)

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Check the .gitignore file to verify the coverage directory has been added correctly.

Check the ci workflow file to see the coverage files generation.

Detailed testing steps

  1. Run tests with coverage enabled (TEST_COVERAGE=1 pnpm test)
  2. Verify that the generated coverage directory is not tracked by git
  3. Run git status to confirm the coverage directory is ignored

.github/workflows/ci.yaml Outdated Show resolved Hide resolved
@monilpat monilpat merged commit ffd5e0a into elizaOS:develop Dec 12, 2024
3 of 4 checks passed
@monilpat monilpat deleted the ci/generate-coverage-files-to-upload-to-codecov branch December 12, 2024 22:21
@snobbee
Copy link
Contributor Author

snobbee commented Dec 17, 2024

Test comment

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.

3 participants