Release 0.5.0 - Podman Support

[0.5.0] - 2025-11-10

Added

• Podman Support: Full container management support using Podman as Docker alternative (#24)
  • podman-compose.yml configuration file for declarative container management
  • Comprehensive usage documentation with three approaches: Direct CLI, Podman Compose, and Dev Container CLI
  • Detailed comparison table of all Podman usage options with pros/cons analysis
  • SELinux context handling guide for Linux users (:Z flag)
  • Installation instructions for multiple platforms
  • Proper initialization script execution order documentation

Changed

• Command Optimizations: Refactored all 6 Cursor command files for improved AI execution efficiency
  • Reduced command file size by ~2000 lines while maintaining functionality
  • Improved clarity and execution flow in create-pr, git-commit, solve-issue, tag-and-release, yolo-issue, and create-issue commands
  • Enhanced command structure for better AI parsing and execution\n\n---\n\nFull Changelog: 0.4.1...0.5.0

Release 0.4.1 - Build System Fix

[0.4.1] - 2025-11-10

Fixed

• Build System: Aligned PROJECT variable with actual source directory (#22)
  • Changed Makefile PROJECT from technical-documentation to docs
  • Resolves build failure where build-diagrams.py couldn't find project directory
  • Build now correctly looks for diagrams in /workspace/docs/diagrams

---

Full Changelog: 0.4.0...0.4.1

Release 0.4.0

Added

• Automated Release Workflow Commands
  • /create-pr enhancement: AI-powered version bump and CHANGELOG generation
    • Analyzes commits (BREAKING CHANGE, feat:, fix:) and actual code changes
    • Examines code diffs intelligently (APIs, signatures, user-facing changes)
    • Suggests Semantic Versioning-compliant bump with rationale
    • Executes make bump-patch/minor/major based on user choice
    • AI auto-generates CHANGELOG entry in proper Keep a Changelog format
    • Creates versioned section directly (no [Unreleased] needed)
    • Version bump committed to PR branch before merge
    • Refinable during PR review
  • /tag-and-release: Streamlined tag and release creation
    • Validates prerequisites (main branch, clean directory)
    • Checks version consecutiveness (no gaps allowed)
    • Validates CHANGELOG.md format (Keep a Changelog compliance)
    • Creates annotated git tag with release notes from CHANGELOG
    • Pushes tag to remote
    • Creates GitHub release with comparison link

Changed

• Release Workflow
  • Version bumping moved to PR creation stage (in /create-pr)
  • CHANGELOG entries created during PR with AI assistance
  • No [Unreleased] section - versions determined at PR time
  • Cleaner git history - no post-merge version bump commits
  • Integrated workflow: create-pr bumps version → merge PR → tag-and-release creates release

---

Full Changelog: 0.3.3...0.4.0

Release 0.3.3 - Version Management System

🎯 Highlights

Automated version management system with pyproject.toml as single source of truth!

✨ Added

Version Management System

• scripts/get_version.py: Extract version from pyproject.toml
• scripts/bump_version.py: Automated semantic version bumping
  • Supports major, minor, patch version bumps
  • Auto-updates CHANGELOG.md with version and date
  • Dry-run mode for previewing changes
  • Comprehensive error handling and validation
• Makefile targets for version management:
  • make version: Display current version
  • make bump-patch: Bump patch version (0.3.2 → 0.3.3)
  • make bump-minor: Bump minor version (0.3.2 → 0.4.0)
  • make bump-major: Bump major version (0.3.2 → 1.0.0)
• docs/VERSION_MANAGEMENT.md: Comprehensive documentation
  • Single source of truth approach with pyproject.toml
  • Release workflow guidelines
  • Best practices for version management
  • Troubleshooting guide

🔧 Changed

• pyproject.toml: Now serves as single source of truth for version numbers
• Makefile: Added version management section to help output

🎁 Benefits

• ✅ Eliminates version number duplication across files
• ✅ Prevents version mismatches between files
• ✅ Automates CHANGELOG.md updates
• ✅ Streamlines release workflow
• ✅ Follows semantic versioning standards
• ✅ Provides both CLI and Make interfaces for version management

🚀 Quick Start

# Show current version
make version

# Bump patch version
make bump-patch

# Dry run to preview changes
python3 scripts/bump_version.py minor --dry-run

📖 Documentation

See docs/VERSION_MANAGEMENT.md for complete documentation.

---

Full Changelog: 0.3.2...0.3.3

Release 0.3.2 - Devcontainer Prerequisites Validation

🎯 Highlights

Comprehensive prerequisites validation system to prevent "login hell" when setting up devcontainers!

✨ Added

Devcontainer Prerequisites Validation

• ✅ 5-step validation script (setup-user-conf.sh)
• ✅ GHCR authentication check (Docker/Podman)
• ✅ SSH public key validation (id_ed25519_github.pub)
• ✅ Allowed-signers file check
• ✅ Git configuration validation (user.name/email)
• ✅ GitHub CLI authentication check
• ✅ Detailed setup instructions for missing prerequisites
• ✅ Clear distinction between required errors and optional warnings
• ✅ Actionable commands to fix issues

📝 Changed

README Documentation

• Added prominent prerequisite validation tip in Requirements section
• Created comprehensive "Host Machine Prerequisites" section
• Added GHCR authentication setup with token creation steps
• Documented Git configuration alternatives for SSH/remote scenarios
• Added SSH key setup with specific naming requirements
• Documented allowed-signers file setup
• Added GitHub CLI authentication instructions
• Created "Quick Validation - Test All Logins" section
• Updated Quick Start with "Test All Logins and Prerequisites" step
• Added note about Docker/Podman interchangeability

Setup Scripts

• Enhanced setup-user-conf.sh with environment variable fallback
• Added GIT_USER_NAME and GIT_USER_EMAIL environment variable support for SSH scenarios

🐛 Fixed

• Improved devcontainer setup UX by preventing "login hell"
• Better error messaging for missing prerequisites
• Clear guidance for SSH/remote server scenarios (#18)

🚀 Quick Start

Before opening the devcontainer, run:

.devcontainer/setup-user-conf.sh

This will validate all your logins and show you exactly what needs to be fixed!

---

Full Changelog: 0.3.1...0.3.2

Release 0.3.1 - Documentation Improvements

Release 0.3.1

Documentation improvements and minor fixes following the 0.3.0 release.

Documentation Improvements

• Comprehensive README Rewrite

  • User-focused content explaining what the template can do
  • Complete build system documentation with all make targets
  • Project structure and workflow explanations
  • Diagram creation and customization guides

• Clear Requirements Section

  • Docker Desktop setup instructions
  • Podman Desktop and Podman CLI options
  • Clarified podman machine requirements by platform
  • VS Code and Dev Containers extension requirements

• Improved Quick Start Guide

  • Step 1: Start container runtime (platform-specific)
  • Step 2: Open in devcontainer with detailed instructions
  • Step 3: Build documentation
  • Step 4: View results
  • Now much clearer for new users

Fixes

• Project Structure Paths

  • Corrected all references to use docs/main.typ (not technical-documentation/technical-documentation.typ)
  • Fixed diagram paths to docs/diagrams/
  • Updated project structure diagram
  • Aligned documentation with actual Makefile configuration

• Devcontainer Git Signing

  • Fixed SSH agent integration for git commit/tag signing
  • Works correctly for all users with SSH agent forwarding
  • More secure (private keys never leave host machine)

Additional Changes

• Removed redundant docs/README.md (merged into main README)
• Fixed duplicate heading issues
• Improved Tips section
• Better platform-specific instructions

This is a documentation-only release building on 0.3.0. No functional changes to the build system or template features.

See CHANGELOG.md for complete 0.3.0 feature details.

Release 0.3.0

Release 0.3.0

Major enhancements to development server, documentation generation, and HTML export capabilities.

Development Infrastructure

• Node.js and live-server integration with smart fallback to Python server
• Automatic cache-busting for CSS files using file modification times
• Improved concurrent request handling and server stability
• Fixed devcontainer git signing to use SSH agent forwarding

Python Documentation

• Self-contained documentation generator using griffe for API extraction
• Automatic API reference generation with test coverage integration
• Google-style docstring support with structured parsing
• Complete V-Model development lifecycle example

Typst Enhancements

• Checklist support with customizable icons
• Theme-aware diagrams with automatic color switching
• Unicode superscripts/subscripts for isotope notation in HTML export
• Enhanced technical documentation package

Bootstrap Integration

• Bootstrap 5.3.2 support with complete styling workflow
• Responsive mobile-first design with Bootstrap grid
• Bootstrap Offcanvas TOC sidebar for better mobile navigation
• Custom styles for Typst-specific enhancements

Build System

• Restructured all outputs to use build/ directories
• Unified example and main build processes
• New Makefile targets for Bootstrap, Python API docs, and diagrams
• Simplified gitignore patterns for build artifacts

HTML Export Improvements

• Better accessibility with Unicode text instead of SVG fragments
• Smaller HTML file sizes with improved text selection
• Support for both custom CSS and Bootstrap workflows
• Fixed regex bugs preventing content deletion

Documentation

• Migrated all documentation from Markdown to Typst format
• Enhanced example project with complete technical documentation suite
• Comprehensive stakeholder analysis with multiple data sources
• Technical diagrams with Fletcher (architecture, data flow, state machines)

Fixes

• Fixed devcontainer git signing to work correctly with SSH agent forwarding
• Fixed 2-column table width issues in HTML export
• Fixed dark mode support for Fletcher diagrams
• Fixed HTTP server stability issues

See CHANGELOG.md for complete details.