Skip to content

Conversation

@grdsdev
Copy link
Contributor

@grdsdev grdsdev commented Nov 12, 2025

Summary

This PR implements Phase 4: Developer Experience Improvements from the workflow improvement plan tracked in SDK-516.

Changes

  1. Workflow Status Badges

    • Added badges for all 8 package workflows to the main README
    • Provides at-a-glance visibility of CI status for each package
    • Badges show: gotrue, postgrest, storage_client, realtime_client, functions_client, supabase, supabase_flutter, coverage
  2. Test Result Summaries

    • Added automatic test summaries using GitHub Actions job summaries ($GITHUB_STEP_SUMMARY)
    • Each test run generates a formatted summary showing:
      • Pass/fail status with visual indicators (✅/❌)
      • Package name and SDK version
      • Working directory
      • Docker services requirement status
    • Summaries are generated even if tests fail (if: always())
    • Makes it easier to understand test results without digging through logs
  3. Test Coverage Reporting

    • Added coverage generation for stable SDK runs only
    • Uses the coverage package to generate lcov reports
    • Uploads coverage artifacts with 7-day retention
    • Developers can download coverage reports to review locally
    • Coverage is generated after tests complete successfully

Technical Details

  • Modified .github/workflows/dart-package-test.yml to add summary and coverage steps
  • Updated README.md with workflow status badges
  • Coverage step runs on matrix.sdk == 'stable' only to avoid redundant coverage generation
  • Test step now uses continue-on-error: true to allow summary generation even on failure
  • Added final check step to ensure workflow fails if tests failed

Testing

This PR should be tested by:

  • Verifying badges appear correctly on the README
  • Running workflows and checking that summaries are generated
  • Verifying coverage artifacts are uploaded for stable SDK runs
  • Ensuring workflows still fail when tests fail

Related Issues

  • Addresses Phase 4 of SDK-516

🤖 Generated with Claude Code

This commit adds several developer experience improvements to the CI workflows:

1. **Workflow Status Badges**: Added badges for all package workflows to the
   main README.md, providing at-a-glance visibility of test status for each package.

2. **Test Summaries**: Added automatic test result summaries to workflow runs
   using GitHub Actions job summaries. Each test run now generates a formatted
   summary showing pass/fail status, package name, SDK version, and whether
   Docker services were required.

3. **Coverage Reporting**: Added test coverage generation for stable SDK runs.
   Coverage reports are generated using the `coverage` package and uploaded
   as artifacts for 7 days, allowing developers to download and review coverage
   locally.

These improvements enhance visibility into CI status and make it easier to
understand test results at a glance.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@grdsdev grdsdev mentioned this pull request Nov 12, 2025
5 tasks
Simplified Phase 4 developer experience improvements by removing:
- Test result summaries (GitHub step summaries)
- Coverage report generation
- Coverage artifact uploads

Phase 4 now only includes:
- Workflow status badges in README.md

This keeps the workflow simpler and focuses on essential visibility
improvements through badges without the overhead of generating
summaries and coverage reports that aren't needed.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@grdsdev
Copy link
Contributor Author

grdsdev commented Nov 12, 2025

Simplified Phase 4

Removed test summaries and coverage artifacts to keep this phase focused and simple.

What was removed:

  • ❌ Test result summaries (GitHub step summaries)
  • ❌ Coverage report generation
  • ❌ Coverage artifact uploads

What remains:

  • ✅ Workflow status badges in README.md

This simplification keeps the workflow cleaner and focuses on the most essential visibility improvement - the status badges that show at-a-glance health of all package workflows.

Commit: fc76185

@grdsdev grdsdev closed this Nov 12, 2025
@grdsdev grdsdev deleted the feat/workflow-phase4-developer-experience branch November 12, 2025 16:55
@coveralls
Copy link

Pull Request Test Coverage Report for Build 19305200698

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 79.75%

Totals Coverage Status
Change from base Build 19299130655: 0.0%
Covered Lines: 3320
Relevant Lines: 4163

💛 - Coveralls

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