Skip to content

Latest commit

 

History

History
195 lines (137 loc) · 4.12 KB

roadmap.md

File metadata and controls

195 lines (137 loc) · 4.12 KB

Roadmap

Current status and planned features for NixActions.


Current Status: v4.0

NixActions v4.0 implements the core vision:

GitHub Actions execution model + Nix reproducibility + Actions as Derivations


Phase 1: MVP - COMPLETED

  • Actions as derivations (build-time compilation)
  • Build-time validation
  • Executor provisioning with 5-hook model
  • Condition system (job + step level)
  • Built-in conditions: success(), failure(), always(), cancelled()
  • Bash script conditions
  • Local executor with workspace/job isolation
  • OCI executor with buildLayeredImage
  • Shared and isolated modes for OCI
  • Cross-platform support (Darwin -> Linux containers)
  • Basic actions library
  • Retry mechanism (3 backoff strategies)
  • Timeout handling
  • Artifacts management with custom restore paths
  • Environment providers (file, sops, static, required)
  • Matrix job generation (mkMatrixJobs)
  • Structured logging (3 formats)
  • Executor deduplication by name
  • 30+ working examples
  • Comprehensive test suites

Phase 2: Remote Executors - IN PROGRESS

SSH Executor

  • Basic SSH executor (shared mode)
  • nix-copy-closure integration
  • Artifact transfer via SCP
  • Environment passing
  • Pool mode (multiple hosts)
  • Dedicated mode (per-job connection)

Kubernetes Executor - COMPLETED

  • Pod creation/deletion
  • kubectl cp for artifacts
  • Environment via -e flags
  • Shared pod mode
  • Dedicated pod mode
  • PVC support for /nix/store (future enhancement)

NixOS VM Executor

  • VM generation from NixOS config
  • 9p filesystem for /nix/store
  • SSH control channel
  • Dedicated mode (per-job VMs)

Phase 3: Ecosystem

Extended Actions Library

  • More setup actions (Go, Java, etc.)
  • Cloud provider actions (AWS, GCP, Azure)
  • Container registry actions
  • Notification actions (Slack, Discord, etc.)
  • Database actions

Documentation

  • Architecture documentation
  • API reference
  • User guide
  • Tutorial series
  • Video walkthroughs
  • Cookbook/recipes

Developer Experience

  • Better error messages
  • Workflow visualization
  • Dry-run mode
  • Watch mode for development

Phase 4: Production Hardening

Reliability

  • Graceful shutdown handling
  • State recovery on failure
  • Distributed locking for pool executors
  • Health checks for remote executors

Observability

  • OpenTelemetry integration
  • Prometheus metrics
  • Log aggregation support
  • Tracing across jobs

Security

  • Secret scanning in logs
  • Audit logging
  • RBAC for multi-tenant setups
  • Secure artifact storage

Phase 5: Advanced Features

Caching

  • Build cache sharing
  • Artifact caching across workflows
  • Remote cache support

Triggers

  • Git webhook integration
  • Cron scheduling
  • Event-driven execution

UI/Dashboard

  • Web UI for workflow status
  • Real-time log streaming
  • Historical runs
  • Metrics dashboard

Non-Goals

These are explicitly out of scope:

  • GitHub Actions compatibility - Not trying to run GitHub Actions YAML
  • Marketplace - Use Nix packages instead
  • Hosted service - Run your own infrastructure
  • Agent daemon - Agentless by design

Contributing

Want to help? Check:

  1. GitHub Issues for open tasks
  2. CONTRIBUTING.md for guidelines
  3. The items marked with [ ] above

Priority areas:

  • SSH executor implementation
  • Documentation improvements
  • More examples
  • Bug fixes

Version History

v4.0 (Current)

  • Actions as Derivations
  • 5-Hook Executor Model
  • OCI executor with buildLayeredImage
  • Full condition system
  • Retry mechanism
  • Environment providers

v3.0 (Legacy)

  • String-based action composition
  • Basic executor model
  • Limited conditions

See Also