You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add comprehensive version nomenclature documentation across all files
- Updated main README.md with current version (v3.1.3) and complete version format explanation
- Updated entity counts from 29 to 35 entities throughout documentation
- Added comprehensive version nomenclature section to main README with practical examples
- Updated specifications README.md to reflect consolidated build system (build.sh)
- Enhanced WORKFLOWS.md with detailed CI/CD version extraction and usage patterns
- Created comprehensive VERSION.md with complete reference documentation
- Updated CHANGELOG.md to document the Git-based version nomenclature system
- All documentation now explains v3.1.3-5-gaac45b1 format with traceability benefits
Provides complete understanding of Git describe-based versioning across development,
CI/CD, and production environments with precise build reproduction capabilities.
Copy file name to clipboardExpand all lines: README.md
+70-7Lines changed: 70 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
## Overview
4
4
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.
5
5
6
-
**Current Version: v3.0.3** - Docker containerized builds, automatic releases for all semantic versions, and comprehensive GitHub Actions workflow automation.
6
+
**Current Version: v3.1.3** - Consolidated build system with enhanced LaTeX error detection, automated version management, and comprehensive GitHub Actions workflow automation.
@@ -107,7 +107,7 @@ W3C Community Group page: [BOOST-01](https://www.w3.org/community/boost-01/)
107
107
## 🚀 Getting Started
108
108
109
109
### For Developers
110
-
1.**Explore the Interactive ERD**: Use the [Interactive ERD Navigator](erd-navigator/index.html) to explore all 29 entities with dynamic filtering and GitHub discussion integration
110
+
1.**Explore the Interactive ERD**: Use the [Interactive ERD Navigator](erd-navigator/index.html) to explore all 35 entities with dynamic filtering and GitHub discussion integration
111
111
2.**Review Entity Schemas**: Check `drafts/current/schema/` for JSON validation schemas and examples
112
112
3.**Review Schema Organization**: Check entity schemas in `drafts/current/schema/` for implementation details
113
113
4.**Migration Guide**: See `drafts/current/specifications/MATERIALBATCH_TO_TRU_MIGRATION_GUIDE.md` for conceptual changes
@@ -128,7 +128,7 @@ W3C Community Group page: [BOOST-01](https://www.w3.org/community/boost-01/)
128
128
The [Interactive ERD Navigator](erd-navigator/index.html) provides a comprehensive, stakeholder-friendly way to explore the BOOST data model:
129
129
130
130
### 🔍 Key Features
131
-
-**29 Entity Coverage**: Complete visualization of all entities across 7 thematic areas
131
+
-**35 Entity Coverage**: Complete visualization of all entities across 7 thematic areas
132
132
-**Dynamic Filtering**: Focus on specific domains (Core Traceability, Organizational, Material & Supply, etc.)
133
133
-**Direct Discussion Access**: Purple 💬 icons in each entity header link directly to GitHub discussions
134
134
-**TraceableUnit Focus Mode**: 🎯 button to reduce visual complexity and highlight essential relationships
@@ -157,11 +157,74 @@ Each entity has a dedicated GitHub discussion thread accessible via the ERD. Thi
157
157
158
158
-**✅ Complete**: BOOST Traceability System Phases 1-3 implementation
159
159
-**✅ Complete**: Plant part categorization system
160
-
-**✅ Complete**: 29 entity schemas with validation and examples
160
+
-**✅ Complete**: 35 entity schemas with validation and examples
161
161
-**✅ Complete**: Interactive ERD Navigator with GitHub discussion integration
162
162
-**✅ Complete**: Integration testing scenarios and migration documentation
163
163
-**🔄 Active**: Community feedback integration and use case expansion
164
164
165
+
## 🏷️ Version Nomenclature
166
+
167
+
BOOST uses Git-based semantic versioning with development build identification. Understanding the version format is essential for tracking releases and development progress.
168
+
169
+
### Version Format: `v3.1.3-5-gaac45b1`
170
+
171
+
All BOOST versions follow the **Git describe** format, providing precise traceability:
172
+
173
+
#### **Components Breakdown:**
174
+
175
+
1.**`v3.1.3`** - **Base Release Tag**
176
+
- Latest official release using semantic versioning (Major.Minor.Patch)
177
+
- Example: `v3.1.3` represents a patch release in the 3.1.x series
178
+
179
+
2.**`-5`** - **Commits Since Release**
180
+
- Number of commits made since the base release tag
181
+
- Indicates this is a **development build**, not an official release
182
+
- Higher numbers = more development activity since last release
183
+
184
+
3.**`-g`** - **Git Indicator**
185
+
- Standard Git convention indicating the following is a commit hash
186
+
- The "g" stands for "git"
187
+
188
+
4.**`aac45b1`** - **Commit Hash (Short)**
189
+
- 7-character abbreviated SHA hash of the specific commit
190
+
- Uniquely identifies the exact code state used for this build
191
+
- Full hash is longer (e.g., `aac45b1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q`)
192
+
193
+
### **Version Types:**
194
+
195
+
| Format | Type | Description | Example |
196
+
|--------|------|-------------|---------|
197
+
|`v3.1.3`|**Release**| Official tagged release | Stable, production-ready |
198
+
|`v3.1.3-5-gabc123`|**Development**| 5 commits after v3.1.3 | In-progress development |
199
+
|`v3.2.0-1-gdef456`|**Post-Release**| 1 commit after new release | Latest development |
200
+
201
+
### **Development Build Evolution:**
202
+
203
+
```
204
+
v3.1.3 ← Official release (tagged)
205
+
v3.1.3-1-g0057230 ← 1 commit after release
206
+
v3.1.3-2-gca1a0c6 ← 2 commits after release
207
+
v3.1.3-3-g2615374 ← 3 commits after release
208
+
v3.1.3-4-gfe2beb4 ← 4 commits after release
209
+
v3.1.3-5-gaac45b1 ← 5 commits after release (current example)
210
+
```
211
+
212
+
### **Practical Usage:**
213
+
214
+
-**🎯 Exact Reproduction**: Any version can be reproduced with `git checkout <commit-hash>`
215
+
-**📋 Issue Reporting**: Always include full version for accurate debugging
216
+
-**🚀 Release Planning**: Development versions show progress toward next release
217
+
-**🔍 Build Tracking**: CI/CD systems use this for automated version management
218
+
219
+
### **In Documentation Builds:**
220
+
221
+
-**HTML/PDF Headers**: Show exact version used for generation
222
+
-**Build Logs**: Include version for reproducibility tracking
223
+
-**Release Artifacts**: Tagged with precise version information
224
+
-**GitHub Actions**: Automatically extract and use for build naming
225
+
226
+
This versioning system ensures **complete traceability** - you can always identify the exact code state that generated any documentation build or release artifact.
227
+
165
228
## 🤖 Automated CI/CD Workflows
166
229
167
230
The BOOST repository includes comprehensive GitHub Actions automation for documentation building, validation, and release management.
0 commit comments