docs: add project documentation
All checks were successful
CI / Lint & Check (push) Successful in 11s
All checks were successful
CI / Lint & Check (push) Successful in 11s
This commit is contained in:
69
ROADMAP.md
Normal file
69
ROADMAP.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Roadmap
|
||||
|
||||
## Phase 1: Foundation (Complete)
|
||||
|
||||
Core functionality implemented:
|
||||
|
||||
- [x] Project listing
|
||||
- [x] Repository listing
|
||||
- [x] Artifact listing and details
|
||||
- [x] Vulnerability display with filtering
|
||||
- [x] Scan triggering with wait
|
||||
- [x] Tag management
|
||||
- [x] SBOM retrieval
|
||||
- [x] Artifact/tag deletion
|
||||
- [x] Project configuration
|
||||
- [x] CI pipeline (syntax + lint)
|
||||
- [x] Modular package structure (`src/harbor/`)
|
||||
|
||||
## Phase 2: Quality
|
||||
|
||||
Code quality and maintainability improvements:
|
||||
|
||||
- [x] Add type hints throughout
|
||||
- [x] Modular code organization
|
||||
- [ ] Add unit tests for core functions
|
||||
- [ ] Add integration tests (mock API)
|
||||
- [ ] Improve error messages
|
||||
- [x] Add `--version` flag
|
||||
- [ ] Add `--quiet` mode for scripting
|
||||
|
||||
## Phase 3: Output
|
||||
|
||||
Terminal output improvements:
|
||||
|
||||
- [ ] Unicode status indicators
|
||||
- [ ] Color output (with NO_COLOR support)
|
||||
- [ ] Table alignment fixes
|
||||
- [ ] Progress indicators for long operations
|
||||
- [ ] JSON output mode for all commands
|
||||
|
||||
## Phase 4: Features
|
||||
|
||||
Additional functionality:
|
||||
|
||||
- [ ] `labels` command - manage artifact labels
|
||||
- [ ] `copy` command - copy artifact between repos
|
||||
- [ ] `gc` command - show garbage collection status
|
||||
- [ ] `replication` command - list replication rules/executions
|
||||
- [ ] `quota` command - show project quota usage
|
||||
- [ ] `audit` command - show audit logs
|
||||
- [ ] Partial digest tab completion
|
||||
|
||||
## Phase 5: Distribution
|
||||
|
||||
Packaging and distribution:
|
||||
|
||||
- [ ] pyproject.toml with entry points
|
||||
- [ ] Installable package (`pip install .`)
|
||||
- [ ] Man page generation
|
||||
- [ ] Shell completions (bash/zsh/fish)
|
||||
|
||||
## Dependencies
|
||||
|
||||
```
|
||||
Phase 1 (done) ──> Phase 2 ─┬─> Phase 3
|
||||
└─> Phase 4 ──> Phase 5
|
||||
```
|
||||
|
||||
Phase 3 and 4 can proceed in parallel after Phase 2.
|
||||
Reference in New Issue
Block a user