Skip to content

ci: install codecov#36

Merged
snipsnipsnip merged 5 commits intoexteditor:mainfrom
snipsnipsnip:codecov
Oct 9, 2025
Merged

ci: install codecov#36
snipsnipsnip merged 5 commits intoexteditor:mainfrom
snipsnipsnip:codecov

Conversation

@snipsnipsnip
Copy link
Copy Markdown
Member

No description provided.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 9, 2025

📝 Walkthrough

Summary by CodeRabbit

  • New Features

    • None
  • Documentation

    • Updated README: roadmap statuses, milestones links, new “Rate the add-on” entry, and added badges for review and coverage.
  • Tests

    • Introduced coverage testing command and alias; enhanced dependency report output with a startup instruction.
  • Chores

    • Integrated Codecov coverage upload in build and PR checks; labeled PR workflow runs.
    • Adjusted .gitignore patterns and added .ignoreme. rule.
  • Refactor

    • Improved error handling to log warnings during removal steps.

Walkthrough

CI workflows now run coverage-enabled tests and upload reports to Codecov. package.json adds coverage scripts and dependency. README gains badges and roadmap/milestones updates. .gitignore adjusts patterns and adds a new wildcard. A test utility adds a startup instruction line. A tooling script now warns on removal errors.

Changes

Cohort / File(s) Summary
Coverage integration (CI + scripts)
.github/workflows/*, package.json
Workflows switch test to coverage variant and add Codecov upload via codecov-action@v5 using token; package.json adds test:coverage and cov scripts and @vitest/coverage-v8 devDependency.
Documentation updates
README.md
Adds CodeRabbit and Codecov badges; updates roadmap statuses, adds milestones references/links, and new contributing/help entries.
Ignore rules
.gitignore
Changes directory ignores to wildcard patterns for .vscode and .zed; adds pattern for .ignoreme..
Test utility output text
src/test/util/dependency_reporter.ts
Inserts a new instructional line and spacing before a code block in the dependency graph dump.
Tooling error logging
tools/barrelsby.ts
Catch block now logs a warning with path and error when removal fails.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant GH as GitHub Actions
  participant Job as CI Job
  participant Test as Vitest (coverage)
  participant Codecov as Codecov

  Dev->>GH: Push / PR
  GH->>Job: Start workflow (build / check-pr)
  Job->>Test: Run tests with coverage
  Test-->>Job: Coverage reports (lcov, etc.)
  Job->>Codecov: Upload reports (codecov-action@v5, token)
  Codecov-->>Job: Acknowledge upload
  Job-->>GH: Complete workflow
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hop through pipes where test reports flow,
Little greens of coverage start to grow.
I thump, “Upload!”—Codecov hears,
Badges shine bright between the gears.
With tidy ignores and warnings that sing,
This burrow’s ready for the next spring. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request lacks any description and does not follow the required template. It is missing sections such as the license agreement checkbox, change category, descriptions of current and new behavior, and testing instructions. Please add a PR description following the provided template including the license agreement checkbox, change category, details on current and new behavior, steps to manually test the changes, and any additional context.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title uses a clear conventional commit prefix and directly references adding Codecov to the CI configuration, which is the central change in this pull request. It is concise and avoids unnecessary details or noise. A teammate scanning the history should immediately understand that CI is modified to install Codecov.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0365a and 6390cdb.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (7)
  • .github/workflows/build.yml (2 hunks)
  • .github/workflows/check-pr.yml (2 hunks)
  • .gitignore (1 hunks)
  • README.md (10 hunks)
  • package.json (3 hunks)
  • src/test/util/dependency_reporter.ts (1 hunks)
  • tools/barrelsby.ts (1 hunks)
🔇 Additional comments (14)
package.json (1)

31-31: LGTM!

The test:coverage script, cov alias, and @vitest/coverage-v8 dependency are correctly configured. The coverage provider version (^3.2.4) properly matches the vitest version (^3.2.4), ensuring compatibility.

Also applies to: 44-44, 74-74

tools/barrelsby.ts (1)

19-21: LGTM!

The improved error handling logs a warning when file removal fails instead of silently swallowing the error. This enhances observability while maintaining backward compatibility by still returning a resolved promise.

.gitignore (2)

3-4: LGTM!

Changing from .vscode/ and .zed/ to .vscode/* and .zed/* allows the directories themselves to be tracked while ignoring their contents. This pattern enables committing editor-specific configuration files while excluding user-specific settings.


7-7: LGTM!

The *.ignoreme.* pattern provides a convenient way for developers to create temporary test files that won't be committed. This aligns with the test utility change that references startup.ignoreme.nolint.test-d.ts.

src/test/util/dependency_reporter.ts (1)

82-83: LGTM!

The added instruction line improves developer experience by clearly indicating where to place the generated startup code. The suggested filename (startup.ignoreme.nolint.test-d.ts) aligns with the new .gitignore pattern (*.ignoreme.*), ensuring the temporary test file won't be accidentally committed.

.github/workflows/check-pr.yml (3)

2-2: LGTM!

The run-name field improves workflow visibility in the GitHub Actions UI by showing which user triggered the PR check.


47-47: LGTM!

Switching to test:coverage enables code coverage reporting, and the --reporter=github-actions flag ensures proper formatting of test results in the GitHub Actions logs.


49-52: Ensure CODECOV_TOKEN is configured
The Codecov upload step uses codecov/codecov-action@v5 and requires the CODECOV_TOKEN secret. Please verify it is set in the repository’s secrets before merging.

.github/workflows/build.yml (2)

47-47: LGTM!

Switching to test:coverage with the GitHub Actions reporter ensures coverage data is collected and properly formatted in CI logs, consistent with the check-pr workflow.


67-70: LGTM!

The Codecov upload step is correctly configured, mirroring the implementation in check-pr.yml for consistency. Both workflows now track coverage on their respective triggers (push vs pull_request).

README.md (4)

259-260: LGTM!

The new badges for CodeRabbit and Codecov properly document the project's use of these tools. The Codecov badge includes the repository token parameter, which will display coverage percentage once reports are uploaded.


106-107: LGTM!

Adding the milestones link reference improves project navigation and aligns with the roadmap updates throughout the document.

Also applies to: 269-269


140-147: LGTM!

The roadmap updates correctly reflect the project's progression: v0.2.1 is marked as Released, and v0.3.0 is marked as Current with the notifications feature.


189-189: LGTM!

Adding "Rate the add-on" entries with the review link encourages community engagement and provides users with a clear call-to-action to support the project.

Also applies to: 237-237, 283-283


Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 9, 2025

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@snipsnipsnip snipsnipsnip added this pull request to the merge queue Oct 9, 2025
Merged via the queue into exteditor:main with commit 7a456b6 Oct 9, 2025
4 checks passed
@snipsnipsnip snipsnipsnip deleted the codecov branch October 9, 2025 03:45
@github-project-automation github-project-automation bot moved this from 📥️Inbox to 🪺Experimental in Ghostbird Issues Oct 9, 2025
@snipsnipsnip snipsnipsnip moved this from 🪺Experimental to ✅Closed in Ghostbird Issues Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

1 participant