docs: prepare 0.7 release#62
Merged
Merged
Conversation
CHANGELOG: prepend [0.7.0] section covering operation logs, savepoints, atomic undo (with per-user filtering and undo-of-undo), auto-savepoints, the relational directory structure, and the v0.6 -> v0.7 history-format migration as the single breaking change. Date placeholder (YYYY-MM-DD) remains for fill-in at tag time. README: lead the Agent Skills section with savepoint/undo as the headline agent capability. Expand the History/Savepoints/Undo section into four labeled subsections (browse past versions, browse what happened, savepoints, granular undo) sized proportionally to the Data-First section. Add "With an agent" subsections under both file-first (log introspection + planned undo) and data-first (schema exploration + modification-with-confirmation) modes. Update tagline to "A versioned filesystem backed by PostgreSQL, and a filesystem interface to PostgreSQL. Built for agents." Refresh Project Status Highlights to surface 0.7 capabilities and rewrite several bullets from technical-feature listings to user/agent value statements.
The 0.7 release introduces several facts the docs need to acknowledge consistently: the BEFORE-INSERT tombstone trigger and 'create' operation value in history; the relational directory parent-pointer model from ADR-017; the post-v0.6 history-format-migration boundary from ADR-019; the atomic-rename pattern in client writes that makes each logical save show as 2-3 log entries; new dot-directory paths .log/, .savepoint/, .undo/. spec.md: history-table CHECK constraint adds 'create'; trigger description covers INSERT/UPDATE/DELETE; Executive Summary surfaces log/savepoints/undo as a marquee bullet; Revision History gains a v1.4 entry; Undo execution steps expanded to 5 with details on SET CONSTRAINTS DEFERRED, the recursive-CTE topological sort for affected-files ordering, the inline version_id capture in steps 2-3, and the explicit modified_at bump. history.md: trigger description mentions INSERT branch; new note in the Operation Log section about atomic-rename writes producing 2-3 log entries per save; Quick Reference adds the .undo/to-id/ row; "Recovering Past Versions" example uses the working .history/<file>/.id -> .log/.by/file_id/ idiom instead of the broken .by/filename/. file-first.md: savepoint name in the History and Undo example switched to "before-refactor" for cross-doc consistency. data-first.md: new "Accessing File-First Backing Tables" section explaining .tables/<workspace>/ access and the history-trigger bypass caveat; "See Also" expanded with cross-references to file-first.md and history.md. quickstart.md: stale "no trash/undo" line in the Important Notes list now distinguishes data-first deletes (permanent) from file-first workspaces (reversible via .undo/); new Example 4 (Building a File-First Workspace) and Example 5 (Savepoints and Undo); existing Examples 4-7 renumbered to 6-9. ADR-012: superseded by ADR-016/017 (status banner updated). ADR-016: Section 1 trigger description mentions INSERT branch and 'create' tombstone; new "See Also" cross-references ADR-012, ADR-017, ADR-019, spec.md, and history.md. ADR-017: history-table CHECK adds 'create'; "0.7 update" note in the BEFORE trigger section explains the post-decision INSERT extension; migration discussion cross-references ADR-019 as the policy mechanism that handles the lossy historical-parent_id issue.
Rewrite step 1 to start an ephemeral Postgres 18 + TimescaleDB container and run the full unit suite in one command with PG env set, so DB-requiring tests that silently skip without PGHOST/TEST_DATABASE_URL actually execute. Documents the container setup/teardown explicitly. Add step 1b for migration testing -- when a release introduces or modifies tigerfs migrate migrations, verify them end-to-end against a previous-release-state workspace. Uses explicit connection strings for self-contained reproduction. Step 2 now reminds the release author to replace the YYYY-MM-DD date placeholder before tagging; the style-reference for CHANGELOG entries points at v0.5.0/v0.6.0 (more representative than v0.1.0/v0.2.0). Step 4 snapshot-build path uses a glob for the darwin_arm64 directory name (the Go-version suffix changes between releases). Step 5 git-add list replaces the explicit three-file enumeration with the more flexible "git add CHANGELOG.md README.md docs/" + git status verification pattern, so contributors don't forget to stage doc updates that happened to be in other files.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three docs-only commits bringing repository documentation up to date for the 0.7 release (operation logs, savepoints, atomic undo, auto-savepoints, relational directory structure, and the v0.6 → v0.7 history-format migration boundary).
826c55d-- CHANGELOG and README. Prepends[0.7.0]section to CHANGELOG. README gets a rewritten Agent Skills section (leading with savepoint/undo), an expanded History/Savepoints/Undo section (four labeled subsections matching Data-First's size), two new "With an agent" subsections showing natural-language interactions for file-first (log introspection + planned undo) and data-first (schema exploration + modification-with-confirmation) modes, refreshed Project Status Highlights, and the updated tagline "A versioned filesystem backed by PostgreSQL, and a filesystem interface to PostgreSQL. Built for agents."b0411b2-- spec, ADRs, and user-facing docs sync. Brings spec.md, history.md, file-first.md, data-first.md, quickstart.md, and ADRs 012/016/017 in sync with several 0.7 facts: BEFORE-INSERT tombstone trigger and'create'history operation; relational directory parent-pointer model; post-v0.6 history-format-migration boundary (ADR-019); atomic-rename pattern in client writes producing 2-3 log entries per logical save; new dot-directories.log/,.savepoint/,.undo/. Quickstart adds Example 4 (Building a File-First Workspace) and Example 5 (Savepoints and Undo), renumbering existing data-first examples to 6-9.081166b-- release-process improvements. Rewrites the test step to start an ephemeral PG18 + TimescaleDB container and run the full unit suite in one command (DB-requiring tests no longer silently skip). Adds step 1b for migration testing when a release shipstigerfs migratemigrations. Reminds the release author to fill in the CHANGELOG date placeholder. Updates the snapshot-build path glob and thegit addpattern. Standalone operational improvement; not specifically tied to 0.7.No code changes. No version constant bumps (build-time injected by goreleaser from the git tag).