docs: add changelog, release workflow, and README cleanup - #34
Merged
Conversation
The repo carried version 1.1.0 in pyproject.toml while the newest tag was v1.0.0, with no changelog and no release automation. This adds the missing pieces and fixes the docs that had drifted. CHANGELOG.md, following Keep a Changelog 1.1.0, seeded with 1.1.0 and a baseline 1.0.0 entry. Contributors add their own lines under Unreleased. .github/workflows/release.yml publishes a GitHub Release on a vX.Y.Z tag, using that version's changelog section as the notes. It refuses to publish unless the tag and pyproject.toml agree and the changelog section exists, which is exactly the drift that made this necessary. README fixes: - Quickstart pointed at assets/demo_input.mp4, which was never committed, and defaulted to a gated segmentation model. Now uses the committed test clip and segformer-b2, verified end to end. - Removed three duplicated sections (camera setup, outputs, viser viewer). - Fixed a markdown link nested in a code span, a code block left with a trailing backslash, a dangling anchor, and an orphaned section that had lost its heading. - Documented the previously missing --replacement-radius-*, --refine-intrinsics-from-mapper, --classes, and LoGeR window flags, and the full mapping_outputs.npz key set that a resumed run reads back. Also adds 1.1.0, and commits the gopro_hero_12 camera profile, which shipped in list-profiles but was untracked and undocumented.
evanjt
approved these changes
Aug 21, 2026
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
2 participants
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.
Why
pyproject.tomlsaid1.1.0while the newest tag wasv1.0.0, with no changelog and no release automation. This adds the missing pieces and fixes docs that had drifted.What
CHANGELOG.md— Keep a Changelog 1.1.0, seeded with1.1.0and a baseline1.0.0. Contributors add their own lines underUnreleased..github/workflows/release.yml— publishes a GitHub Release on avX.Y.Ztag, using that version's changelog section as the notes. Refuses to publish unless the tag andpyproject.tomlagree and the changelog section exists. Already exercised: it built and published v1.1.0.README fixes
assets/demo_input.mp4, which was never committed, and defaulted to a gated segmentation model. Now uses the committed test clip andsegformer-b2— verified end to end.--replacement-radius-*,--refine-intrinsics-from-mapper,--classes, and LoGeR window flags, plus the fullmapping_outputs.npzkey set a resumed run reads back.Also —
deepreefmap --version, and thegopro_hero_12profile, which shipped inlist-profilesbut was untracked and undocumented.Verified
uv buildsucceeds in a submodule-free worktree (matching CI checkout)Follow-up, not in this PR
The release wheel contains zero
logerfiles, because the workflow checks out withsubmodules: false.pyproject.tomlsays LoGeR is vendored into the wheel;THIRD_PARTY_NOTICES.mdsays to keep it out of release archives while its license is unresolved. This PR implements the second reading by omission — worth making deliberate either way.🤖 Generated with Claude Code