Repository navigation
Releases: ymmt2005/pbschema-lens
Release list
v0.7.1
v0.7.0
Complete static pages. Clearer protobuf documentation.
v0.7.0 makes generated documentation easier to read and more dependable to navigate, with complete HTML from Go and improved Markdown formatting for protobuf comments.
Explore the live demo · Installation guide
Highlights
Documentation you can read without JavaScript
Go now renders complete documentation pages at build time, including symbol pages and the source browser. Headings, links, and fragment targets are present in the generated HTML, so reading and ordinary navigation work with JavaScript disabled—and static link checkers can inspect the actual pages. (#50)
Search, theme controls, and the used-by picker still use JavaScript. The released binary needs no Node runtime; publish the generated site to GitHub Pages or another static HTTP host.
Protobuf comments that read like documentation
Markdown comments now have clear heading levels, paragraph spacing, visible list markers, styled blockquotes, and distinct inline code. Code blocks use compact spacing, and wide code blocks and Markdown tables scroll within their own area. Styling works in light and dark themes, including narrow screens. Long comments such as google.protobuf.FieldMask are much easier to follow. (#53)
More checks behind every release
Expanded browser tests and offline link checks cover internal pages and fragments at both root and project base paths, JavaScript-disabled reading, anchor positioning, 320px layouts, theme behavior, configuration variants, and a real schema diff. (#48, #51)
Upgrading
Regenerate and publish your documentation with v0.7.0 to get the new HTML and typography.
Comment formatting change: a single newline in prose now reflows as a normal Markdown soft break. Use a blank line for a new paragraph, two trailing spaces or a backslash for an explicit line break, and fenced code blocks for examples or ASCII diagrams whose spacing must be preserved.
Downloads below include macOS, Linux, and Windows archives for amd64 and arm64, plus checksums.txt. You can also install with aqua.
Full changelog
All changes, including maintenance updates
- 626c63f release: v0.7.0 (#59)
- 5b7e6ac ci: upgrade setup-node, aqua-installer and GoReleaser actions (#58)
- d7378e6 feat: add Codex skill and deterministic Action updater (#57)
- 97fa810 deps: monthly dependency updates (#56)
- f8b3148 fix: activate selected runtimes before dependency resolution (#55)
- bbc28a3 Automate monthly dependency updates with a deterministic workflow (#54)
- 298e588 Improve Markdown typography and wrapping in protobuf comments (#53)
- 6d862bd Complete focused E2E coverage and check links with aqua-managed lychee (#51)
- 5920b18 Render complete static documentation pages in Go (#50)
- 798d656 Add a Playwright suite for the built site shell (#48)
- 4706b44 Document installing with aqua (#47)
v0.6.2
v0.6.1
pbschema-lens has been rewritten in Go and no longer requires Node to run.
Breaking changes since v0.5
- Plugins are not loaded. Remove plugins from the config. A non-empty list fails the build.
buf breakingis not run. diff compares two FileDescriptorSets and does not invoke Buf.- The commit in repository links comes from
--commitorsource.commit. pbschema-lens does not rungit rev-parse.
v0.6.0
Rewritten the CLI in Go, but the rendering has significantly degraded. will fix in the next release.
v0.5.0
v0.4.0
What's Changed
- Show proto sources as a folder and file tree by @ymmt2005 in #21
- Make the package tree disclosure chevron easier to see by @ymmt2005 in #22
- Give each RPC method its own page by @ymmt2005 in #23
- Highlight which side of an RPC streams by @ymmt2005 in #24
- Remove the browser descriptor playground by @ymmt2005 in #25
- Omit documentation.exclude files from the site, and import google.api and buf.validate via Buf by @ymmt2005 in #26
- Honor wellKnownTypes.enabled for standard-library pages by @ymmt2005 in #28
- Always enable symbol search by @ymmt2005 in #29
- Set a quality bar for every change by @ymmt2005 in #31
- Test decisions at the size the quality bar asks for by @ymmt2005 in #32
- Bump to v0.4.0 by @ymmt2005 in #33
Full Changelog: v0.3.0...v0.4.0
v0.3.0
What's Changed
- Document the GitHub Release procedure by @ymmt2005 in #12
- Create a GitHub Release when main bumps the version by @ymmt2005 in #13
- Move the README release procedure under Develop by @ymmt2005 in #14
- Note that published GitHub Releases are immutable by @ymmt2005 in #15
- Use the full content width for the Fields table by @ymmt2005 in #16
- Fold API Reference packages into a tree by @ymmt2005 in #17
- Refresh the README home screenshot by @ymmt2005 in #18
- Fix broken anchor links and missing reference pages by @ymmt2005 in #19
- Bump version to 0.3.0 by @ymmt2005 in #20
Full Changelog: v0.2.1...v0.3.0
v0.2.1
v0.1.0
What's Changed
- Add README screenshots of the Acme example by @ymmt2005 in #1
- Fix GitHub Pages base path docs for private sites by @ymmt2005 in #2
- Add CI status badge to README by @ymmt2005 in #3
- Add AGENTS.md for coding agents by @ymmt2005 in #4
- Add specialized renderer for cybozu.validate options by @ymmt2005 in #5
- Show validation rules in a dedicated field-table column by @ymmt2005 in #6
- Group oneof members under the oneof in the field table by @ymmt2005 in #7
- Create a GitHub Release tarball when a semver tag is pushed by @ymmt2005 in #8
New Contributors
Full Changelog: https://github.com/ymmt2005/pbschema-lens/commits/v0.1.0