Skip to content

feat: Add firmware summary table to AI release notes#79

Merged
fxstein merged 7 commits intodevelopfrom
feat/ai-release-summary-firmware-info-20-20250629-150000
Jun 29, 2025
Merged

feat: Add firmware summary table to AI release notes#79
fxstein merged 7 commits intodevelopfrom
feat/ai-release-summary-firmware-info-20-20250629-150000

Conversation

@fxstein
Copy link
Copy Markdown
Owner

@fxstein fxstein commented Jun 29, 2025

Summary

This PR enhances the GoProX AI release summary process by adding a comprehensive firmware summary table that shows supported GoPro models and their latest official and labs firmware versions.

Requirements

  • Add firmware summary table to AI release notes
  • Table should appear at the very top of release notes (before main header)
  • Include all supported GoPro models with latest firmware versions
  • Sort models in custom order: HERO13 → HERO (2024) → HERO12 → HERO11 → HERO11 Mini → HERO10 → HERO9 → HERO8 → GoPro Max → The Remote
  • Handle models with spaces in names correctly
  • Use proper markdown table formatting with aligned columns

Motivation

Users need immediate visibility into which GoPro models are supported by GoProX and what the latest firmware versions are. This information should be prominently displayed at the top of all release notes.

Acceptance Criteria

  • Firmware summary script generates clean, properly formatted markdown table
  • Table includes all supported models from firmware directories
  • Models are sorted in the specified custom order
  • Table handles model names with spaces correctly (e.g., 'HERO (2024)', 'HERO11 Black Mini')
  • Unknown models are sorted by firmware version at the top
  • AI release instructions updated to mandate firmware table inclusion
  • Table renders cleanly in markdown with proper column alignment
  • Script is future-proof for new models

Reference

  • Issue Workflow: Implement git-flow Model #20: AI release summary firmware info enhancement
  • AI_INSTRUCTIONS.md updated with new requirements
  • RELEASE_SUMMARY_INSTRUCTIONS.md updated with firmware table mandate

fxstein added 6 commits June 29, 2025 15:16
- Create generate-firmware-summary.zsh script to automatically generate firmware support table
- Add mandatory firmware summary section to release instructions
- Include current firmware status at top of all release notes
- Provide users with immediate visibility into supported models and latest firmware versions
- Generate clean table showing Model | Latest Official | Latest Labs format
- Calculate optimal column widths based on content length
- Use printf formatting for consistent spacing and alignment
- Generate proper separators that match column widths
- Ensure headers align with content below
- Improve readability with left-aligned content
- Sort models in priority order: HERO13, HERO (2024), HERO12, HERO11, HERO11 Mini, HERO10, HERO9, HERO8, GoPro Max, The Remote
- Replace alphabetical sorting with custom order for better user experience
- Maintain fallback to alphabetical for any models not in custom order
- Automatically place newer models (higher firmware versions) at the top of the list
- Sort unknown models by firmware version in descending order
- Maintain custom order for known models (HERO13, HERO12, etc.)
- Future-proof design: new models added will automatically appear at the top
- HERO (2024) now correctly appears first due to highest firmware version
… order (refs #20)

- Use robust string comparison for custom order matching
- Remove all debug output for clean production use
- Table now matches user-specified order exactly, including HERO (2024)
@fxstein fxstein added the enhancement New feature or request label Jun 29, 2025
@fxstein fxstein self-assigned this Jun 29, 2025
@github-actions
Copy link
Copy Markdown

🧪 Test Results

All tests passed

Test Suites Executed:

  • Configuration Tests
  • Parameter Processing Tests
  • Storage Validation Tests
  • Integration Tests

📊 Test Reports: Available in workflow artifacts
🔍 Test Logs: Available in workflow artifacts


Generated by GoProX Comprehensive Testing Framework

@github-actions
Copy link
Copy Markdown

🧪 Test Results

All tests passed

Test Suites Executed:

  • Configuration Tests
  • Parameter Processing Tests
  • Storage Validation Tests
  • Integration Tests

📊 Test Reports: Available in workflow artifacts
🔍 Test Logs: Available in workflow artifacts


Generated by GoProX Comprehensive Testing Framework

@fxstein fxstein merged commit 5a33ddb into develop Jun 29, 2025
8 checks passed
@fxstein fxstein deleted the feat/ai-release-summary-firmware-info-20-20250629-150000 branch June 29, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant