Skip to content

fix: track the API release by its tag prefix, not the repository's latest - #181

Merged
kristoferlund merged 1 commit into
mainfrom
fix/api-release-tag-prefix
Nov 3, 2026
Merged

kristoferlund merged 1 commit into
mainfrom
fix/api-release-tag-prefix

Conversation

@kristoferlund

Copy link
Copy Markdown
Contributor

Summary

hypercerts-org/api now releases two packages: the server modules (@hypercerts-org/happyview-modules@0.3.0) and the npm package @hypercerts-org/api@0.1.0, both released on 2026-11-03. GitHub marks only one release per repository as "latest", currently @hypercerts-org/api@0.1.0, so docs generation would fail on the API source: it read /releases/latest and expected the server modules' tag.

  • lib/external-docs-snapshot.js: a source with releaseTagPrefix now takes the newest stable (not draft, not prerelease) release with that prefix from the repository's release list. A repository with no releases is still "unreleased"; one whose releases include none with the prefix is an error, so a wrong prefix cannot silently show "unreleased". Sources without a prefix still use /releases/latest.
  • docs-sources.yml: the API source tracks @hypercerts-org/happyview-modules@, the tag prefix since the rename in client: add @hypercerts-org/api with record types from @hypercerts-org/lexicon/records api#45 (follow-up to fix: read the API changelog from happyview-modules/ #180).
  • Tests: the API source test now covers another package's newer release, a skipped prerelease, no releases, no matching release, and an invalid version.

pnpm test passes (81 tests). Generating against GitHub shows the API at v0.3.0 and the Lexicons at v2.0.0.

The @hypercerts-org/api npm package itself has no page on the docs site yet; that is separate.

…test

hypercerts-org/api now releases two packages, and GitHub marks the npm
package @hypercerts-org/api@0.1.0 as the repository's latest release. A
source with releaseTagPrefix now takes the newest stable release with that
prefix from the release list. The API page tracks
@hypercerts-org/happyview-modules@.
@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hypercerts-v0.2-documentation Ready Ready Preview Nov 3, 2026 9:28am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 3, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 60a2b7bb-79fa-4a9b-8a80-fad2eae524c4
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.

@kristoferlund
kristoferlund merged commit c664ed6 into main Nov 3, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
Preview — a84b66f0 Deployed Nov 3, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant