Skip to content
rlsbl.changelog.home
Updated
On this page

The one resolver for where a generated CHANGELOG.md belongs: the project root for a standalone repository, the releasable's own directory in a workspace.

#rlsbl.changelog.home

#rlsbl.changelog.home

Single source of truth for where generated CHANGELOG.md files live, resolving the correct directory for standalone projects and for releasables.

Three consumers previously disagreed about the changelog home in explicit releasable mode: the release flow wrote CHANGELOG.md into the representative member's directory, rlsbl changelog generate wrote it into the releasable's directory, and the changelog-entry check expected the releasable's directory. This module is the ONE resolver all of them (plus undo and the GitHub-Release-notes hint) must go through.

Semantics:

  • Standalone projects (no releasable): the canonical CHANGELOG.md lives at

the project root, exactly as before.

  • Releasable members (explicit monorepo mode): the canonical CHANGELOG.md

lives in the releasable's state directory (.rlsbl-monorepo/releasables/<name>/CHANGELOG.md). Additionally, a combined root CHANGELOG.md at the workspace root covers ALL releasables of the workspace, one section per releasable in workspace.toml order.

#get_changelog_home

python
def get_changelog_home(project_dir: str, *, releasable_dir: str | None=None) -> str

Return the canonical CHANGELOG.md path.

releasable_dir is the releasable's state directory (.rlsbl-monorepo/releasables/<name>/); when given, the canonical changelog lives there. Otherwise it lives at the project root.

#get_workspace_changelog_path

python
def get_workspace_changelog_path(workspace_root: str) -> str

Return the path of the combined root CHANGELOG.md for a workspace.

#_strip_canonical_header

python
def _strip_canonical_header(content: str) -> str

Strip the generated-file comment and the '# Changelog' H1 from a canonical per-releasable changelog, leaving only the version sections.

#generate_workspace_changelog

python
def generate_workspace_changelog(workspace_root: str, *, write_to_disk: bool=True) -> str

Generate the combined root CHANGELOG.md covering all releasables.

Reads each releasable's canonical CHANGELOG.md (in workspace.toml order), strips its header, and emits it under a top-level heading named after the releasable. Releasables without a canonical changelog on disk are omitted. For a single-releasable workspace this yields that releasable's changelog at the root (under its name heading).

Returns the generated content. When write_to_disk is True, writes it to the workspace root (skipping the write if content is unchanged).

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • selfdoc Static Site Generator that builds a project's documentation site directly from its source code, so the docs can never drift from the code they describe, with SEO/AEO, first-class blog, search, and cross-project linking built in
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search