Skip to content

Commit f15f70a

Browse files
pwt-cdclaude
andcommitted
ENHANCE: Add automatic version updates to GitHub Pages landing page
- Enhanced GitHub Actions workflow to inject current version into landing page - Added version info banner, build timestamp, and recent improvements section - Added {{VERSION}} placeholder to README.md for future automation - Landing page now shows current version, build time, and system status automatically - Added links to enhancement planning and improved visual presentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent b3aedc3 commit f15f70a

File tree

2 files changed

+118
-5
lines changed

2 files changed

+118
-5
lines changed

.github/workflows/build-deploy.yml

Lines changed: 81 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,11 @@ jobs:
362362
run: |
363363
mkdir -p ./pages-content
364364
365+
# Process README.md with version replacement for GitHub Pages
366+
echo "🔧 Processing README.md with version replacement..."
367+
sed "s|{{VERSION}}|${{ needs.extract-version.outputs.version }}|g" README.md > ./pages-content/README.md
368+
echo "✅ README.md processed with version ${{ needs.extract-version.outputs.version }}"
369+
365370
# List downloaded artifacts for debugging
366371
echo "📋 Downloaded artifact structure:"
367372
find build-output -type f -name "*.html" -o -name "*.pdf" -o -name "*.md" | head -10
@@ -418,11 +423,20 @@ jobs:
418423
<style>
419424
body {
420425
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
421-
max-width: 800px;
422-
margin: 50px auto;
426+
max-width: 900px;
427+
margin: 40px auto;
423428
padding: 20px;
424429
line-height: 1.6;
425430
}
431+
.version-info {
432+
text-align: center;
433+
margin-bottom: 20px;
434+
padding: 10px;
435+
background: #e8f4fd;
436+
border-radius: 5px;
437+
font-weight: 500;
438+
color: #0366d6;
439+
}
426440
.hero-section {
427441
text-align: center;
428442
margin-bottom: 40px;
@@ -458,9 +472,39 @@ jobs:
458472
margin-bottom: 30px;
459473
font-size: 16px;
460474
}
475+
.recent-changes {
476+
margin: 30px 0;
477+
padding: 25px;
478+
background: #f6f8fa;
479+
border-radius: 8px;
480+
border-left: 4px solid #28a745;
481+
}
482+
.recent-changes h3 {
483+
margin-top: 0;
484+
color: #24292e;
485+
}
486+
.status-grid {
487+
display: grid;
488+
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
489+
gap: 15px;
490+
margin: 20px 0;
491+
}
492+
.status-item {
493+
padding: 15px;
494+
background: white;
495+
border-radius: 6px;
496+
border: 1px solid #e1e4e8;
497+
}
498+
.status-item .check { color: #28a745; font-weight: bold; }
461499
</style>
462500
</head>
463501
<body>
502+
<div class="version-info">
503+
<strong>Current Version: ${{ needs.extract-version.outputs.version }}</strong> |
504+
Built: ${{ needs.extract-version.outputs.build-timestamp }} |
505+
<a href="https://github.com/carbondirect/BOOST" style="color: inherit;">View on GitHub</a>
506+
</div>
507+
464508
<div class="hero-section">
465509
<h1>🌱 BOOST Data Standard</h1>
466510
<p class="description">
@@ -471,8 +515,34 @@ jobs:
471515
<a href="./boost-spec.html" class="main-button">📖 View Documentation Online</a>
472516
</div>
473517
518+
<div class="recent-changes">
519+
<h3>🚀 Recent Improvements</h3>
520+
<div class="status-grid">
521+
<div class="status-item">
522+
<div class="check">✅</div>
523+
<strong>Enhanced Collaboration</strong><br>
524+
GitHub Issues-based enhancement planning with stakeholder engagement
525+
</div>
526+
<div class="status-item">
527+
<div class="check">✅</div>
528+
<strong>35 Entities Documented</strong><br>
529+
Complete JSON Schema validation across 7 thematic areas
530+
</div>
531+
<div class="status-item">
532+
<div class="check">✅</div>
533+
<strong>CI/CD Integration</strong><br>
534+
Automated quality gates with comprehensive testing
535+
</div>
536+
<div class="status-item">
537+
<div class="check">✅</div>
538+
<strong>Documentation Consistency</strong><br>
539+
100% cross-format validation between PDF and HTML
540+
</div>
541+
</div>
542+
</div>
543+
474544
<div class="download-links">
475-
<h2>📥 Download & Resources</h2>
545+
<h2>📥 Documentation & Resources</h2>
476546
EOF
477547
478548
# Add PDF link if PDF exists
@@ -486,9 +556,16 @@ jobs:
486556
cat >> ./pages-content/index.html << EOF
487557
<a href="./erd-navigator/">🔍 ERD Navigator</a>
488558
<a href="https://github.com/carbondirect/BOOST/tree/main/drafts/current/schema">📋 JSON Schemas</a>
559+
<a href="https://github.com/carbondirect/BOOST/issues?q=label%3Aplan">✅ Enhancement Planning</a>
489560
</div>
490561
491-
<p><em>Choose how you'd like to access the BOOST Data Standard documentation above.</em></p>
562+
<div style="text-align: center; margin-top: 40px; padding: 20px; border-top: 1px solid #e1e4e8;">
563+
<p style="margin: 0; color: #666;">
564+
<strong>BOOST W3C Community Group</strong> |
565+
<a href="https://github.com/carbondirect/BOOST">GitHub Repository</a> |
566+
<a href="https://www.w3.org/community/boost-01/">W3C Community Group</a>
567+
</p>
568+
</div>
492569
</body>
493570
</html>
494571
EOF

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
## Overview
2121
This repository contains the working draft and artifacts of the Biomass Open Origin Standard for Tracking (BOOST), which defines a robust and interoperable data model for tracking biomass through complex supply chains. The standard supports transparent, verifiable, and consistent data exchange to enable sustainability, regulatory compliance, and supply chain integrity.
2222

23-
**Current Version: v3.1.3** - Consolidated build system with enhanced LaTeX error detection, automated version management, and comprehensive GitHub Actions workflow automation.
23+
**Current Version: {{VERSION}}** - Enhanced collaboration with GitHub Issues-based enhancement planning, build system improvements, and comprehensive documentation consistency validation.
2424

2525
- **Charter:** [BOOST_Charter.org](BOOST_Charter.org)
2626
- **Charter Effective Date:**
@@ -30,6 +30,42 @@ Feedback and contributions are welcomed via GitHub Issues and Pull Requests at [
3030

3131
W3C Community Group page: [BOOST-01](https://www.w3.org/community/boost-01/)
3232

33+
## 📋 Documentation Access
34+
35+
### **Primary Documentation**
36+
- **[📄 Complete PDF Specification](https://carbondirect.github.io/BOOST/boost-spec.pdf)** - 88+ page comprehensive specification with all 35 entities
37+
- **[🌐 Interactive HTML Specification](https://carbondirect.github.io/BOOST/boost-spec.html)** - W3C-compliant browsable documentation
38+
- **[📊 Interactive ERD Navigator](https://carbondirect.github.io/BOOST/erd-navigator/)** - Visual exploration of entity relationships and data model
39+
- **[🗂️ JSON Schema Repository](https://github.com/carbondirect/BOOST/tree/main/drafts/current/schema)** - 35 validation schemas (single source of truth)
40+
41+
### **Development Resources**
42+
- **[📈 Build and Consistency Reports](https://github.com/carbondirect/BOOST/tree/main/drafts/current/specifications/build)** - Automated validation and generation statistics
43+
- **[📝 Complete Version History](https://github.com/carbondirect/BOOST/blob/main/drafts/current/specifications/CHANGELOG.md)** - Detailed change documentation
44+
- **[✅ Enhancement Planning](https://github.com/carbondirect/BOOST/issues?q=label%3Aplan)** - GitHub Issues-based project planning with stakeholder collaboration
45+
46+
## 🚀 Recent Changes & Improvements
47+
48+
### **Latest Updates (v3.2.3+)**
49+
- **📋 Enhanced Collaboration**: Migrated all enhancement plans to GitHub Issues ([#259](https://github.com/carbondirect/BOOST/issues/259)-[#262](https://github.com/carbondirect/BOOST/issues/262)) for improved stakeholder engagement and transparency
50+
- **🔧 Build System Refinements**: Resolved HTML generation consistency issues and header formatting problems
51+
- **🧹 Documentation Organization**: Streamlined planning documents and improved developer experience
52+
- **📝 Stakeholder Materials**: Comprehensive interagency presentation materials for California agency engagement
53+
54+
### **Major Release Features (v3.0.0)**
55+
- **🚀 Enterprise CI/CD Pipeline**: Complete GitHub Actions automation with PR validation, schema integrity checking, and automated deployment
56+
- **🧪 Local Testing Infrastructure**: Full development environment with 80-90% CI/CD simulation capabilities for faster iteration
57+
- **🛡️ Critical Schema Integrity**: Fixed validation patterns for GeographicData, MaterialProcessing, and TraceableUnit entities
58+
- **🎨 Professional Layout System**: ReSpec-based responsive design with mobile optimization and W3C compliance
59+
- **📊 Complete Entity Coverage**: All 35 entities documented across 7 thematic areas with full cross-format consistency validation
60+
61+
### **Current System Status**
62+
-**Entity Coverage**: 35/35 entities documented with complete JSON Schema validation
63+
-**Build System**: Unified single-command build process with HTML/PDF generation
64+
-**Documentation Consistency**: 100% cross-format validation between PDF and HTML outputs
65+
-**Version Management**: Automatic git tag-based versioning with complete traceability
66+
-**CI/CD Integration**: Automated quality gates with comprehensive testing and deployment
67+
-**Community Engagement**: GitHub Issues-based enhancement planning with stakeholder collaboration
68+
3369
## 🌟 Key Features
3470

3571
### BOOST Traceability System Implementation

0 commit comments

Comments
 (0)