feat: Add Docker Hub publishing workflow, version roadmap, and update project status documentation.

southpawriter02 · southpawriter02 · commit 603454989289 · 2026-01-02T10:06:30.000-07:00
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -0,0 +1,69 @@
+name: Publish to Docker Hub
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Docker image tag (default: latest)'
+        required: false
+        default: 'latest'
+
+env:
+  REGISTRY: docker.io
+  IMAGE_NAME: git-chronoscope
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ secrets.DOCKERHUB_USERNAME }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=raw,value=${{ github.event.inputs.tag }},enable=${{ github.event_name == 'workflow_dispatch' }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Update Docker Hub description
+        uses: peter-evans/dockerhub-description@v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: ${{ secrets.DOCKERHUB_USERNAME }}/${{ env.IMAGE_NAME }}
+          short-description: "Generate time-lapse visualizations of Git repository evolution"
+          readme-filepath: ./README.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,84 @@
+# Changelog
+
+All notable changes to git-chronoscope will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Docker Hub publishing workflow for multi-architecture images (amd64, arm64)
+- Version roadmap documentation for path to v1.0
+
+### Changed
+- Version scheme updated to 0.9.x beta series before v1.0 release
+
+## [0.9.0] - TBD
+
+First public beta release.
+
+### Features
+- **Core Functionality**
+  - Time-lapse video generation from Git repository history
+  - Commit information overlay (hash, author, date, message)
+  - Multiple output formats: MP4, GIF, HTML interactive timeline
+  - Customizable rendering options (FPS, resolution, themes, fonts, colors)
+
+- **Advanced Features**
+  - Path filtering with `--include` and `--exclude` glob patterns
+  - Branch comparison with `--compare` flag
+  - Author highlighting with unique colors per contributor
+  - Semantic diffing with `--show-diff` flag
+  - Interactive HTML timeline with searchable navigation
+
+- **Performance & Scalability**
+  - Frame caching for faster re-renders
+  - Parallel processing with configurable worker count
+  - Large repository support via `--sample-rate` and `--max-commits`
+  - Date range filtering with `--since` and `--until`
+
+- **Security**
+  - Sensitive data redaction (API keys, passwords, tokens)
+  - Input sanitization against prompt injection
+  - File access control via `.agentignore`
+  - Default blocklists for sensitive files
+  - Filesystem sandboxing
+  - Immutable audit logging
+  - Dry-run mode for previewing actions
+
+- **Integrations**
+  - GitHub Actions workflow
+  - GitLab CI/CD pipeline templates
+  - VS Code extension
+  - Jira issue filtering
+
+- **Distribution**
+  - PyPI package (`pip install git-chronoscope`)
+  - Homebrew formula (`brew install git-chronoscope`)
+  - Standalone executables for Windows, macOS, Linux
+  - Docker image with pre-installed dependencies
+
+- **Web GUI**
+  - Flask-based web interface
+  - Interactive configuration panel
+  - Job history tracking
+  - Real-time progress updates
+  - Preview frame generation
+
+### Documentation
+- Quick start guide
+- Contributing guidelines
+- Troubleshooting guide
+- System requirements
+- Dependencies documentation
+
+---
+
+## Version History
+
+| Version | Status | Focus |
+|---------|--------|-------|
+| 0.9.0 | Beta | First public release |
+| 0.9.x | Beta | Distribution & integrations |
+| 1.0.0 | Planned | Stable release |
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "git-chronoscope"
-version = "1.0.0"
+version = "0.9.0"
 description = "Generate time-lapse visualizations of Git repository evolution"
 readme = "README.md"
 license = {text = "MIT"}
diff --git a/roadmap/README.md b/roadmap/README.md
@@ -4,7 +4,17 @@ This document outlines the roadmap for the Git Time-Lapse project. The project a
 
 ## Implementation Status Overview
 
-**All roadmap items are now implemented! ✅**
+**Core features complete. Distribution and new integrations in progress.**
+
+- Core Functionality: 4/4 ✅
+- Advanced Features: 5/5 ✅
+- Security: 12/12 ✅
+- Performance & Scalability: 3/3 ✅
+- Integrations: 4/4 ✅
+- Non-Functional: 4/4 ✅
+- Distribution: 3/5 (in progress)
+- New Integrations: 0/4 (planned)
+- New Advanced Features: 0/5 (planned for post-1.0)
 
 ### Core Functionality (4/4 ✅)
 
@@ -70,17 +80,19 @@ This document outlines the roadmap for the Git Time-Lapse project. The project a
 
 ---
 
-## Future Features (Not Yet Implemented)
+## Distribution (3/5 ✅)
 
-### Distribution (0/5 ⏳)
+| Feature | Status | Description | Implementation |
+|---------|--------|-------------|----------------|
+| PyPI Package | ✅ | `pip install git-chronoscope` | `.github/workflows/publish.yml` |
+| Homebrew Formula | ✅ | `brew install git-chronoscope` | `Formula/git-chronoscope.rb` |
+| Standalone Executable | ✅ | No Python required | `packaging/`, `.github/workflows/build-executables.yml` |
+| Docker Hub Image | ⏳ | Official Docker image | `Dockerfile` (not yet published) |
+| npm Package | ⏳ | Node.js wrapper | Not started |
 
-| Feature | Status | Description |
-|---------|--------|-------------|
-| PyPI Package | ⏳ | `pip install git-chronoscope` |
-| Homebrew Formula | ⏳ | `brew install git-chronoscope` |
-| Standalone Executable | ⏳ | No Python required |
-| Docker Hub Image | ⏳ | Official Docker image |
-| npm Package | ⏳ | Node.js wrapper |
+---
+
+## Future Features (Not Yet Implemented)
 
 ### New Integrations (0/4 ⏳)
 
diff --git a/roadmap/VERSION_ROADMAP.md b/roadmap/VERSION_ROADMAP.md
@@ -0,0 +1,139 @@
+# Version Roadmap to v1.0
+
+This document outlines the versioning strategy and release plan for git-chronoscope leading up to the official v1.0 release.
+
+## Versioning Strategy
+
+Git-chronoscope follows [Semantic Versioning](https://semver.org/):
+- **0.9.x-beta.N**: Beta releases with new features
+- **0.9.x-rc.N**: Release candidates for stabilization
+- **1.0.0**: First stable production release
+
+## Current Status
+
+**Version**: 0.9.0 (beta)
+
+### What's Complete
+- Core time-lapse generation functionality
+- All advanced visualization features
+- Full security suite (12/12 features)
+- Performance optimizations
+- CI/CD integrations (GitHub, GitLab, VS Code, Jira)
+- Distribution infrastructure (PyPI, Homebrew, executables)
+
+### What's In Progress
+- Docker Hub image publishing
+- npm package wrapper
+
+### What's Planned for v1.0
+- Slack integration
+- Discord bot
+- Linear integration
+
+---
+
+## Release Schedule
+
+### v0.9.0-beta.1 - Distribution Foundation
+**Status**: In Progress
+
+Establish core distribution channels:
+- [x] PyPI package configuration
+- [x] Homebrew formula
+- [x] Standalone executable build scripts
+- [x] Docker Hub CI workflow
+- [ ] First PyPI publication
+- [ ] First Docker Hub publication
+- [ ] First GitHub Release with executables
+
+### v0.9.0-beta.2 - npm Package
+**Status**: Planned
+
+JavaScript ecosystem distribution:
+- [ ] Node.js CLI wrapper
+- [ ] npx zero-install support
+- [ ] npm registry publication
+
+### v0.9.0-beta.3 - Slack Integration
+**Status**: Planned
+
+Team collaboration features:
+- [ ] Slack bot application
+- [ ] `/chronoscope` slash command
+- [ ] Threaded progress updates
+- [ ] Interactive configuration
+
+### v0.9.0-beta.4 - Discord Bot
+**Status**: Planned
+
+Community distribution:
+- [ ] Discord bot using discord.py
+- [ ] Slash commands
+- [ ] Video preview embeds
+
+### v0.9.0-beta.5 - Linear Integration
+**Status**: Planned
+
+Issue tracking support:
+- [ ] Linear API client
+- [ ] `--linear-issue` CLI flag
+- [ ] Webhook triggers
+
+### v0.9.0-rc.1 - Release Candidate
+**Status**: Planned
+
+Stabilization and polish:
+- [ ] Comprehensive cross-platform testing
+- [ ] Documentation review
+- [ ] Performance benchmarking
+- [ ] Security audit
+- [ ] Bug fixes from beta feedback
+
+### v1.0.0 - Official Release
+**Status**: Planned
+
+Production-ready release criteria:
+- [ ] All distribution channels published
+- [ ] Slack and Discord integrations functional
+- [ ] Linear integration complete
+- [ ] Documentation complete
+- [ ] No critical bugs
+- [ ] Security review passed
+
+---
+
+## Post-1.0 Roadmap
+
+Features planned for future major versions:
+
+| Version | Features |
+|---------|----------|
+| v1.1 | Mobile Apps (iOS/Android), Custom Themes |
+| v1.2 | Analytics Dashboard |
+| v1.3 | AI-Powered Narration |
+| v1.4 | Real-Time Streaming |
+| v2.0 | Web Dashboard (SaaS) |
+
+---
+
+## Distribution Matrix
+
+| Channel | v0.9.0 | v1.0.0 |
+|---------|--------|--------|
+| PyPI | ✅ | ✅ |
+| Homebrew | ✅ | ✅ |
+| Standalone | ✅ | ✅ |
+| Docker Hub | ✅ | ✅ |
+| npm | ✅ | ✅ |
+| GitHub Releases | ✅ | ✅ |
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines on contributing to git-chronoscope.
+
+To help with a specific release milestone:
+1. Check the release checklist above
+2. Pick an unchecked item
+3. Open a PR referencing the version target
