|
1 | 1 | # Changelog |
2 | 2 |
|
3 | | -All notable changes to docsiq are published on |
4 | | -[GitHub Releases](https://github.com/RandomCodeSpace/docsiq/releases) |
5 | | -with auto-generated summaries grouped by label (security fixes, breaking |
6 | | -changes, new features, bug fixes, dependencies). Each release is tagged |
7 | | -with its signed SHA256SUMS and SLSA build provenance. |
| 3 | +All notable changes to docsiq are documented here in a human-readable |
| 4 | +form. The full per-commit history is available on |
| 5 | +[GitHub Releases](https://github.com/RandomCodeSpace/docsiq/releases), |
| 6 | +but this file is the curated summary. |
8 | 7 |
|
9 | | -This file summarises notable releases. The canonical source is the |
10 | | -Releases page linked above. |
11 | | - |
12 | | -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) |
| 8 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
13 | 9 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 10 | +Each release ships signed binaries (cosign keyless + Rekor), a signed |
| 11 | +`SHA256SUMS`, and SLSA build provenance. |
14 | 12 |
|
15 | 13 | ## [Unreleased] |
16 | 14 |
|
17 | 15 | ### Added |
18 | | -- Governance and community files: `CODE_OF_CONDUCT.md`, `GOVERNANCE.md`, |
19 | | - `.github/CODEOWNERS`, `.github/release.yml`, `docs/ACCESSIBILITY.md` |
20 | | -- `.bestpractices.json` to track OpenSSF BestPractices criteria |
| 16 | +- `CODE_OF_CONDUCT.md`, `GOVERNANCE.md`, `.github/CODEOWNERS`, |
| 17 | + `.github/release.yml`, `docs/ACCESSIBILITY.md` — project governance |
| 18 | + and community files (OpenSSF BestPractices passing tier). |
| 19 | +- `.bestpractices.json` tracking the full OpenSSF BestPractices matrix |
| 20 | + at repo root (78 Met / 10 N/A / 0 Unknown). |
| 21 | + |
| 22 | +### Changed |
| 23 | +- `SECURITY.md`: added a "Report archive" section clarifying that |
| 24 | + GitHub Issues archives non-sensitive reports and Security Advisories |
| 25 | + archives coordinated-disclosure reports. |
| 26 | +- Release pipeline: dropped GoReleaser (its `prebuilt` builder is a |
| 27 | + Pro-only feature and wasn't parsing in OSS goreleaser). The release |
| 28 | + job now computes SHA256SUMS, signs with cosign keyless, and creates |
| 29 | + the GitHub release directly — signing, provenance, and categorised |
| 30 | + release notes are all preserved. |
| 31 | +- CI: dropped macOS from the test matrix; Linux-only is sufficient to |
| 32 | + gate PRs. The release workflow still builds darwin-arm64 binaries |
| 33 | + natively on macOS runners. |
| 34 | +- CI: removed `push: main` trigger from `ci.yml` and `fuzz.yml`; |
| 35 | + `pull/N/merge` already validates the merged tree. Saves ~2 min of |
| 36 | + runner time per merged PR. `codeql.yml` still runs on push to main |
| 37 | + (the Security tab's default-branch data requires it). |
| 38 | + |
| 39 | +## [0.0.2] — 2026-04-23 |
21 | 40 |
|
22 | 41 | ### Changed |
23 | | -- `SECURITY.md`: added "Report archive" section documenting GitHub Issues |
24 | | - and Security Advisories as the public archive |
25 | 42 |
|
26 | | -## [0.0.2] — 2026-04-20 |
| 43 | +- **Scorecard workflow cadence.** `scorecard.yml` now runs on release |
| 44 | + completion and weekly on schedule instead of firing on every push to |
| 45 | + `main`. The policy being scored is unchanged; this simply stops |
| 46 | + re-scoring commits that don't move any Scorecard-visible state. |
| 47 | + |
| 48 | +### Upgrade impact |
| 49 | + |
| 50 | +Safe drop-in upgrade from v0.0.1. No API, CLI, or on-disk schema |
| 51 | +changes — replace the binary in place. |
| 52 | + |
| 53 | +GitHub Release: <https://github.com/RandomCodeSpace/docsiq/releases/tag/v0.0.2> |
| 54 | + |
| 55 | +## [0.0.1] — 2026-04-23 |
| 56 | + |
| 57 | +First non-beta release. Establishes the feature set and API surface |
| 58 | +that subsequent 0.0.x patches will maintain back-compat against. |
| 59 | + |
| 60 | +### Added |
27 | 61 |
|
28 | | -See <https://github.com/RandomCodeSpace/docsiq/releases/tag/v0.0.2> |
| 62 | +- **GraphRAG indexing pipeline** — five-phase ingestion: chunk, extract |
| 63 | + entities/relationships/claims, community-detect (Louvain), embed, |
| 64 | + persist. |
| 65 | +- **Document loaders** — PDF (langchaingo), DOCX, TXT, Markdown, and a |
| 66 | + polite web crawler with robots.txt + allow-list + MIME checks. |
| 67 | +- **Multi-provider LLM layer** — Azure OpenAI, OpenAI, and Ollama |
| 68 | + behind a single `internal/llm` abstraction. |
| 69 | +- **Query engine** — hybrid local (vector + FTS5) and global |
| 70 | + (community-summary) search. |
| 71 | +- **Surfaces** — CLI (`docsiq index|search|serve`), REST API, MCP |
| 72 | + server, and an embedded React SPA served by `docsiq serve`. |
| 73 | +- **Storage** — single SQLite file with `sqlite_fts5` and `sqlite-vec` |
| 74 | + for vector search. No external DB to deploy. |
| 75 | +- **Signed releases** — cosign keyless via Sigstore (Rekor-anchored), |
| 76 | + signed `SHA256SUMS`, and SLSA build provenance. |
29 | 77 |
|
30 | | -## [0.0.1] — 2026-04-15 |
| 78 | +### Known limitations |
31 | 79 |
|
32 | | -Initial release. |
| 80 | +- Darwin support is limited to `arm64`; `amd64` is not built (cgo + |
| 81 | + sqlite-vec cross-compile complexity). |
| 82 | +- Pre-1.0: APIs and on-disk schema are not yet frozen. |
33 | 83 |
|
34 | | -See <https://github.com/RandomCodeSpace/docsiq/releases/tag/v0.0.1> |
| 84 | +GitHub Release: <https://github.com/RandomCodeSpace/docsiq/releases/tag/v0.0.1> |
0 commit comments