Skip to content

ROADMAP.md

Latest commit

 

History

History
122 lines (66 loc) · 2.59 KB

ROADMAP.md

File metadata and controls

122 lines (66 loc) · 2.59 KB
Raw

omnistorage-github Roadmap

This roadmap documents planned and completed features for this project.

The format is based on and generated by Structured Roadmap, which provides a machine-readable JSON intermediate representation with deterministic Markdown generation.

Overview

This roadmap tracks the development of the GitHub repository backend for OmniStorage.

Other

[x] Read Files

Read file content via GitHub Contents API

Version: 0.1.0 (2026-01-10)

[x] Write Files

Create/update files with automatic commit creation

Version: 0.1.0 (2026-01-10)

[x] Batch Commits

Atomic multi-file operations via Git Trees API

Version: 0.1.0 (2026-01-10)

[x] Delete Files

Delete files with automatic commit creation

Version: 0.1.0 (2026-01-10)

[ ] Large File Support

Support for files larger than 1MB via Git Blobs API

Target: 0.2.0

[x] List Files

List files via GitHub Trees API with prefix filtering

Version: 0.1.0 (2026-01-10)

[ ] Branch Creation

Create branches for isolated changes

Target: 0.2.0

[ ] Caching Layer

Cache file contents and metadata for repeated reads

[x] File Metadata

Get file size and SHA1 hash via Stat

Version: 0.1.0 (2026-01-10)

[x] GitHub Enterprise Support

Support for GitHub Enterprise via custom BaseURL/UploadURL

Version: 0.1.0 (2026-01-10)

[ ] Pull Request Creation

Create pull requests for changes instead of direct commits

Target: 0.2.0

[x] Range Read Support

Read file content with offset and limit

Version: 0.1.0 (2026-01-10)

[ ] Commit History Access

Access file commit history and diffs

[ ] File Blame Information

Get file blame information

[ ] GitHub Actions Integration

Trigger GitHub Actions workflows on file changes

Current Limitations

The following operations are not supported and return ErrNotSupported:

  • Mkdir - GitHub doesn't have explicit directories
  • Rmdir - GitHub doesn't have explicit directories
  • Copy - Would require read + write (multiple commits)
  • Move - Would require read + write + delete (multiple commits)

Contributing

Contributions welcome! Priority areas:

  • Large file support via Git Blobs API
  • Additional test coverage
  • Performance optimizations (caching)
  • Documentation improvements

Version History

Version Date Status Summary
0.1.0 2026-01-10 ✅ Initial release with read, write, batch commits, and GitHub Enterprise support
0.2.0 TBD 📋 Large file support, PR creation, branch management