Skip to content

Latest commit

 

History

History
120 lines (87 loc) · 3.26 KB

DASHBOARD_SUMMARY.md

File metadata and controls

120 lines (87 loc) · 3.26 KB

📊 GitHub Pages Validation Dashboard - Summary

✅ What Was Created

A complete GitHub Pages site has been set up to display real-time metadata validation results from your GitHub Actions workflow.

Files Created

  1. docs/index.html - Main dashboard with responsive design
  2. docs/assets/style.css - Professional styling with light theme
  3. docs/assets/validation.js - Dynamic data loading and display
  4. docs/validation_results.json - Sample data (auto-generated by workflow)
  5. docs/README.md - Comprehensive documentation
  6. GITHUB_PAGES_SETUP.md - Quick setup guide

Workflow Updates

The .github/workflows/validate-metadata.yml file has been modified to:

  • Generate validation results in JSON format
  • Automatically deploy to GitHub Pages on every master branch run

🎨 Dashboard Features

Visual Components

  • Summary Cards: Status, file count, errors, warnings
  • Metadata Display: Timestamp, trigger, branch, schema version
  • Issues List: Detailed breakdown of errors and warnings per study
  • Success Message: When all validations pass
  • Responsive Design: Works on all devices

Color-Coded Indicators

  • 🟢 Green: Validation passed
  • 🔴 Red: Validation failed with errors
  • 🟡 Yellow: Warnings present
  • ℹ️ Blue: Information and metadata

🚀 Setup Required (3 Simple Steps)

1. Enable GitHub Pages

  • Go to Settings → Pages
  • Source: Branch gh-pages, folder / (root)
  • Save

2. Set Permissions

  • Go to Settings → Actions → General
  • Workflow permissions: Read and write
  • Allow Actions to create PRs: ✓
  • Save

3. Run Workflow

Either:

  • Push these changes to master, OR
  • Manually trigger from Actions tab

📍 Dashboard URL

After setup, your dashboard will be live at:

https://waldronlab.github.io/curatedMetagenomicDataCuration/

🔄 Automatic Updates

The dashboard automatically updates when:

  • ✓ Metadata files change (push to master)
  • ✓ Pull requests with metadata changes (validation only)
  • ✓ Daily at 2 AM UTC
  • ✓ Schema updates in OmicsMLRepoCuration
  • ✓ Manual workflow trigger

📖 Documentation

Detailed guides available:

  • GITHUB_PAGES_SETUP.md - Quick start guide
  • docs/README.md - Complete documentation with troubleshooting

🎯 What Happens Next

  1. Commit & Push the new files
  2. Workflow runs and validates metadata
  3. JSON file generated with results
  4. Dashboard deployed to GitHub Pages
  5. View results at your GitHub Pages URL

🔍 Preview

The dashboard is already viewable locally! It should have opened in your browser showing the sample data (all passing validation).

📊 Data Flow

Metadata Files (*.tsv)
       ↓
GitHub Actions Workflow
       ↓
Validation with OmicsMLRepoCuration
       ↓
validation_results.json
       ↓
GitHub Pages Deployment
       ↓
Live Dashboard

💡 Tips

  • Bookmark the dashboard URL for quick access
  • Check before merging PRs to ensure validation passes
  • Share with team for transparency
  • Monitor daily for schema compatibility

🎉 Ready to Deploy!

All files are ready. Just follow the 3 setup steps in GITHUB_PAGES_SETUP.md to go live!

Need help? Check the troubleshooting section in docs/README.md