Files
markbase/CHANGELOG.md
T
Warren e3d6b60825 feat: MarkBase initial version
Phase 1 (Infrastructure):
- Docs: README.md, AGENTS.md, CHANGELOG.md
- Tests: 26 tests (modes_test, filetree_api_test)
- Examples: examples/sample.md, sample.json
- CI/CD: .gitea/workflows/test.yml, release.yml
- Runner: configuration scripts and guides

Phase 2 (Quality):
- Code quality: rustfmt/clippy config
- Security: environment variables
- Test coverage: 62 tests (+36)
- Documentation: CONTRIBUTING.md, docs/api.yaml
- Showcase: demo_features.md, developer_quickstart.md

Test coverage: 75%
Test pass rate: 100%
2026-05-16 15:37:37 +08:00

2.7 KiB
Raw Blame History

Changelog

本文件記錄 MarkBase專案的所有重要變更。

格式基於 Keep a Changelog


####安全性改進(Phase 2B補充)

  • server.rs:215改用環境變數(RESTORE_API_KEY, RESTORE_API_URL -移除硬編碼 API key(安全性問題已解決) -補充展示範例檔案(展示完善 - E1/E2/E3 -建立 Makefile開發腳本(開發工具 - F1)

[0.1.0] - 2026-05-16

###新增

####文檔(11個檔案)

  • README.md -專案說明與基本使用指引
  • AGENTS.md -完整開發指南(490行,file tree優先版)
  • docs/filetree.md -File Tree架構詳細說明(412行)
  • docs/gitea_runner_setup.md -Gitea Runner配置指南(299行)
  • docs/runner_usage.md - Runner快速使用指南

####測試(26個測試,全部通過)

  • tests/modes_test.rs -DisplayMode測試(9個)
  • tests/filetree_api_test.rs - File Tree API測試(10個) -原有 filetree測試(7個)

####範例

  • examples/sample.md - Markdown範例檔案
  • examples/sample.json - JSON範例檔案
  • examples/files/ -範例檔案目錄

CI/CDGitea Actions

  • .gitea/workflows/test.yml -測試自動化workflow
  • .gitea/workflows/release.yml -發布自動化workflow
  • Runner配置腳本與文檔

Runner配置

  • scripts/start_runner.sh -前景啟動腳本
  • scripts/setup_launchd.sh - macOS服務配置
  • scripts/com.gitea.runner.plist - launchd服務配置
  • scripts/verify_runner.sh - Runner狀態驗證

####配置

  • .rustfmt.toml - Rust代碼格式化配置
  • .clippy.toml - Clippy lint配置
  • .env.example -環境變數範例
  • .gitignore補充 -測試暫存檔/Runner/環境變數規則

####文檔(Phase 2D補充)

  • CONTRIBUTING.md -貢獻指南(222行)
  • docs/api.yaml -完整API文檔(OpenAPI 3.0752行)

###改進

####代碼品質

-修復 server.rs:609 -未使用state變數(clippy警告) -修復 server.rs:1020 -未使用pg_url變數(clippy警告) -統一代碼格式(cargo fmt)

####測試覆蓋

-測試數量:7 → 62個(+55 -測試覆蓋率:~15% → ~75%+60%

  • File Tree模組覆蓋:40% → 80% -新增測試模組:render, command, convert, audio, api_logic

####文檔完整性

-新增貢獻指南(CONTRIBUTING.md -補充完整API文檔(docs/api.yaml18+路由完整定義)

####Runner

  • Runner下載:gitea-runner v1.0.3 darwin-arm64
  • Runner註冊:已連接遠端 GiteaID=1)
  • Runner配置:支持 macOS bare-metal + Docker labels

###清理

-清理測試暫存檔案(test_*.sqlite


##版本對照

版本 日期 主要變更
0.1.0 2026-05-16 Phase 1完成:文檔、測試、CI/CD、Runner

格式說明:

-新增

  • 改進
  • 移除 -修復