Skip to content

chore: release @kagal/build-tsdoc 0.1.0#3

Merged
amery merged 2 commits into
mainfrom
pr-amery-release-0.1.0
May 3, 2026
Merged

chore: release @kagal/build-tsdoc 0.1.0#3
amery merged 2 commits into
mainfrom
pr-amery-release-0.1.0

Conversation

@amery

@amery amery commented May 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Two commits:

  1. Bump @kagal/build-tsdoc to 0.1.0 and promote
    the existing [Unreleased] changelog entries under
    the new version with a 2026-05-03 release date.
  2. Switch the per-package release-tag pattern in
    publish.yml from **/v[0-9]* (Go-modules style)
    to @*/*@[0-9]* — the standard npm form used by
    Lerna in independent mode and by Changesets:
    @scope/name@version. The repo-wide v[0-9]*
    pattern stays for releases where every publishable
    package shares a version. AGENTS.md §Publishing is
    updated in the same commit to document both
    patterns and which is intended for which case.

0.0.1 was a manual bootstrap publish whose only purpose
was to register the package on npm so the trusted-publisher
binding could be configured. The artefact on the registry
is byte-identical to what 0.1.0 will publish — same
sources, same dist/, same exports — only the version
string and changelog change in commit 1.

Goal

0.1.0 is the first release that goes through
publish.yml rather than the bootstrap manual publish.
After this PR merges, tagging the merge commit
@kagal/build-tsdoc@0.1.0 triggers the workflow, which
authenticates to npm via OIDC (id-token: write) and runs
pnpm -r publish:maybe --provenance --no-git-checks.
The result is the first release of @kagal/build-tsdoc
with Sigstore provenance attached.

Test plan

  • pnpm precommit is green (full
    dev:prepare → lint → type-check → build → test
    chain at the root)
  • CI Build job green on the PR
  • Reviewer confirms 0.0.1 → 0.1.0 is the intended
    bump (vs 0.0.2) for the trusted-publisher cut-over
  • Reviewer confirms the new tag pattern
    @*/*@[0-9]* is what we want for per-package
    releases, and that keeping v[0-9]* alongside it
    is the right call for repo-wide releases
  • After merge: tag @kagal/build-tsdoc@0.1.0 on
    the merge commit; publish.yml runs and the npm
    registry shows @kagal/build-tsdoc@0.1.0 with
    provenance

Summary by CodeRabbit

  • New Features

    • Added newDocumentsHook() for build-done hook unbuilding
    • Expanded public API with newly exposed types and error classes for better integration
  • Documentation

    • Updated publishing instructions to clarify supported version-tag patterns

Bump @kagal/build-tsdoc to 0.1.0 and promote the existing
[Unreleased] changelog entries under the new version with a
2026-05-03 release date.

0.0.1 was a manual bootstrap publish whose only purpose was
to register the package on npm so the trusted-publisher
binding could be configured; the contents on the registry
are identical to what 0.1.0 will publish. After this PR
merges, tagging the merge commit `v0.1.0` triggers
publish.yml, which authenticates to npm via OIDC and
publishes with Sigstore provenance — the first signed
release of the package.

Signed-off-by: Alejandro Mery <amery@apptly.co>
@coderabbitai

coderabbitai Bot commented May 3, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4f75c6b3-c95f-460c-aff5-33c068f30bb2

📥 Commits

Reviewing files that changed from the base of the PR and between f63f8ae and c5c7a89.

📒 Files selected for processing (4)
  • .github/workflows/publish.yml
  • AGENTS.md
  • packages/@kagal-build-tsdoc/CHANGELOG.md
  • packages/@kagal-build-tsdoc/package.json

📝 Walkthrough

Walkthrough

This PR releases version 0.1.0 of the @kagal-build-tsdoc package. The workflow trigger expands to support scoped package tags (@*/*@[0-9]*), documentation is updated to reflect both tag patterns, the changelog documents the new release with new hooks and public exports, and the package version is bumped.

Changes

Release 0.1.0 for @kagal-build-tsdoc

Layer / File(s) Summary
Workflow Configuration
.github/workflows/publish.yml
Publish workflow tag trigger expanded from **/v[0-9]* to additionally include @*/*@[0-9]* pattern for scoped package releases.
Documentation
AGENTS.md
Publishing instructions updated to document two accepted version-tag patterns: v[0-9]* for repo-wide releases and @*/*@[0-9]* for per-package scoped releases.
Version Management
packages/@kagal-build-tsdoc/package.json
Package version bumped from 0.0.1 to 0.1.0.
Changelog
packages/@kagal-build-tsdoc/CHANGELOG.md
Release entry added for version 0.1.0 (2026-05-03) documenting: new newDocumentsHook() for build-done hook unbundling, public exports (DocumentsManifest, ExportManifest, DocumentsHookOptions, DocEntry), public errors (DuplicateExportPathError, DuplicateOutputFileError), and constants (DEFAULT_OUTPUT_DIRECTORY, VERSION); migration note from prior @kagal/build-tsdocs package name.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

A rabbit hops with glee,
New version 0.1 to see!
Scoped tags now in flight,
Exports shining bright ✨
Published with Sigstore's might! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: release @kagal/build-tsdoc 0.1.0' directly and clearly describes the main change—bumping the package to version 0.1.0 and releasing it, which aligns with the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pr-amery-release-0.1.0

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Release @kagal/build-tsdoc version 0.1.0

📦 Other

Grey Divider

Walkthroughs

Description
• Bump @kagal/build-tsdoc version from 0.0.1 to 0.1.0
• Promote [Unreleased] changelog entries to 0.1.0 release
• Document first OIDC trusted publishing with Sigstore provenance
• Mark transition from manual bootstrap to automated publishing
Diagram
flowchart LR
  A["Version 0.0.1<br/>Manual Bootstrap"] -- "Promote to Release" --> B["Version 0.1.0<br/>OIDC Trusted Publishing"]
  B -- "Attach Provenance" --> C["Sigstore Signed Release"]
Loading

Grey Divider

File Changes

1. packages/@kagal-build-tsdoc/package.json ⚙️ Configuration changes +1/-1

Bump package version to 0.1.0

• Update version field from 0.0.1 to 0.1.0

packages/@kagal-build-tsdoc/package.json


2. packages/@kagal-build-tsdoc/CHANGELOG.md 📝 Documentation +9/-1

Document 0.1.0 release with provenance details

• Create new [0.1.0] section dated 2026-05-03
• Document first OIDC trusted publishing release
• Explain relationship between 0.0.1 bootstrap and 0.1.0 release
• Add Sigstore provenance context to release notes

packages/@kagal-build-tsdoc/CHANGELOG.md


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 3, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1)

Grey Divider


Remediation recommended

1. cspell:words not before heading 📘 Rule violation ⚙ Maintainability
Description
In CHANGELOG.md, the new cspell directive <!-- cspell:words Sigstore tsdocs --> is placed inside
the section rather than immediately before the section heading. This violates the markdown directive
placement convention and makes spellcheck scope harder to reason about.
Code

packages/@kagal-build-tsdoc/CHANGELOG.md[R8-11]

+## [0.1.0] - 2026-05-03
+
+<!-- cspell:words Sigstore tsdocs -->
+First release published via npm OIDC trusted publishing
Evidence
PR Compliance ID 479611 requires cspell inline directives to be placed immediately before the
markdown heading that introduces the section. The PR adds <!-- cspell:words Sigstore tsdocs -->
after the ## [0.1.0] - 2026-05-03 heading instead of placing it directly above the heading.

Rule 479611: Place cspell inline directives at the preceding section heading
packages/@kagal-build-tsdoc/CHANGELOG.md[8-11]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`<!-- cspell:words Sigstore tsdocs -->` was added inside the `0.1.0` section, but the project convention requires cspell directives to be placed immediately before the heading they apply to.

## Issue Context
This is a markdown changelog section (`## [0.1.0] - 2026-05-03`). Moving the directive above the heading keeps directives consistently located and avoids directives being interpreted as part of lists/tables.

## Fix Focus Areas
- packages/@kagal-build-tsdoc/CHANGELOG.md[8-11]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Replace the `**/v[0-9]*` per-package tag pattern in
publish.yml with `@*/*@[0-9]*`. The `**/vN` form is
the Go modules convention (`module/path/v1.2.3`) and
does not match how npm monorepos tag releases. The
standard npm form — used by Lerna in independent mode
and by Changesets — is `@scope/name@version`, e.g.
`@kagal/build-tsdoc@0.1.0`. The repo-wide `v[0-9]*`
pattern is preserved for releases where every
publishable package shares a version.

Update the AGENTS.md §Publishing section to document
both patterns and call out which is intended for
which case.

Signed-off-by: Alejandro Mery <amery@apptly.co>
@amery amery added release Version bump and release prep build-tsdoc @kagal/build-tsdoc package labels May 3, 2026
@amery amery changed the title chore(build-tsdoc): release 0.1.0 chore: release @kagal/build-tsdoc 0.1.0 May 3, 2026
@amery amery added ci CI/CD workflows and automation documentation Improvements or additions to documentation labels May 3, 2026
@pkg-pr-new

pkg-pr-new Bot commented May 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@kagal/build-tsdoc@3

commit: c5c7a89

@amery
amery merged commit f69620e into main May 3, 2026
11 checks passed
@amery
amery deleted the pr-amery-release-0.1.0 branch May 3, 2026 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build-tsdoc @kagal/build-tsdoc package ci CI/CD workflows and automation documentation Improvements or additions to documentation release Version bump and release prep

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant