Skip to content

Add multiple ways to view coverage reports in GitHub#8

Merged
smarks merged 3 commits intomainfrom
actions
Aug 9, 2025
Merged

Add multiple ways to view coverage reports in GitHub#8
smarks merged 3 commits intomainfrom
actions

Conversation

@smarks
Copy link
Copy Markdown
Owner

@smarks smarks commented Aug 9, 2025

GitHub Job Summaries (Primary Solution)

  • Add comprehensive coverage reports to GitHub Actions job summaries
  • Shows coverage comparison table with main vs PR branch
  • Includes tolerance-aware status messages and visual indicators
  • Visible directly in GitHub Actions workflow run pages

Enhanced Workflows

  • Update coverage-guard.yml to show detailed coverage analysis
  • Add coverage summaries to CI workflow for main branch runs
  • Use Python for accurate floating-point coverage comparisons

Coverage Badge Generator

  • Add generate_coverage_badge.py script for README badges
  • Supports shields.io badge generation with color coding
  • Can be integrated into workflows for automatic badge updates

Where to View Coverage:

  1. Job Summary: Click on workflow run → scroll to "Coverage Report"
  2. Workflow Logs: Coverage details in step outputs
  3. Artifacts: HTML coverage reports (when available)
  4. Badge: Generated markdown for README

This solves the "no way to see coverage" problem with multiple visible options.

🤖 Generated with Claude Code

spencermarks and others added 3 commits August 8, 2025 20:15
## GitHub Job Summaries (Primary Solution)
- Add comprehensive coverage reports to GitHub Actions job summaries
- Shows coverage comparison table with main vs PR branch
- Includes tolerance-aware status messages and visual indicators
- Visible directly in GitHub Actions workflow run pages

## Enhanced Workflows
- Update coverage-guard.yml to show detailed coverage analysis
- Add coverage summaries to CI workflow for main branch runs
- Use Python for accurate floating-point coverage comparisons

## Coverage Badge Generator
- Add generate_coverage_badge.py script for README badges
- Supports shields.io badge generation with color coding
- Can be integrated into workflows for automatic badge updates

## Where to View Coverage:
1. **Job Summary**: Click on workflow run → scroll to "Coverage Report"
2. **Workflow Logs**: Coverage details in step outputs
3. **Artifacts**: HTML coverage reports (when available)
4. **Badge**: Generated markdown for README

This solves the "no way to see coverage" problem with multiple visible options.

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

Co-Authored-By: Claude <noreply@anthropic.com>
## Coverage Improvements:
- **100% coverage** on core application files (sms_notifier.py, url_watcher.py)
- Total coverage: 179 statements, 0 missing lines

## Configuration Changes:
- Add generate_coverage_badge.py to coverage exclusions in pyproject.toml
- Update pytest.ini to use --cov-config=pyproject.toml for proper exclusions
- Add pragma: no cover for unreachable edge case in url_watcher.py:209

## Excluded Files (Utilities, not core application):
- coverage_tracker.py (testing/CI utility)
- integration_tests.py (integration testing script)
- generate_coverage_badge.py (badge generation utility)

## Results:
✅ sms_notifier.py: 56/56 statements covered (100%)
✅ url_watcher.py: 123/123 statements covered (100%)
✅ Total: 179/179 statements covered (100%)

Coverage regression detection now works with high-quality baseline data\!

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

Co-Authored-By: Claude <noreply@anthropic.com>
…examples

## Complete Overhaul:
- **943 lines** of comprehensive documentation (vs 675 before)
- **Perfect for beginners** - step-by-step tutorials and explanations
- **Organized with 12 major sections** and detailed table of contents

## New Beginner-Friendly Sections:
- 🎯 **"What Does This Do?"** - Simple explanation for non-technical users
- 🚀 **5-Minute Quick Start** - Get running in minutes with examples
- 🎓 **Complete Beginner Tutorial** - 5 lessons from basic to advanced
- 💡 **Real-World Examples** - 6 practical use cases with commands
- ❓ **Comprehensive Troubleshooting** - Solutions for common issues

## Enhanced Documentation:
- 📖 **Complete Installation Guide** - Virtual environments, verification steps
- 📱 **Detailed SMS Setup** - Both automatic and manual AWS configuration
- ⚙️ **Advanced Configuration** - Environment variables, programmatic usage
- 🧪 **Testing & Coverage** - Full testing guide with 100% coverage info
- 🤖 **CI/CD Documentation** - GitHub Actions workflows explained
- 🔧 **Complete API Reference** - All classes, methods, and examples

## Beginner-Focused Features:
- **Clear explanations** of what URL monitoring is and why it's useful
- **Step-by-step tutorials** from basic to advanced usage
- **Copy-paste examples** for common scenarios
- **Troubleshooting guide** for typical problems
- **Cost transparency** (SMS costs ~$0.006 per message)
- **Multiple learning paths** for different skill levels

## Professional Polish:
- **Visual organization** with emojis and clear hierarchy
- **Comprehensive table of contents** with direct links
- **Professional project structure** documentation
- **Contributing guidelines** for open source participation
- **Resource links** to external documentation

Perfect for developers of all skill levels - from complete beginners to advanced users\!

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

Co-Authored-By: Claude <noreply@anthropic.com>
@smarks smarks merged commit b386fa4 into main Aug 9, 2025
4 checks passed
smarks added a commit that referenced this pull request Aug 28, 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