rlsbl v0.60.1 /rlsbl.commands.edit_release
On this page

Edit-release command that updates existing GitHub Release notes by extracting the matching version section from CHANGELOG.md.

#rlsbl.commands.edit_release

#rlsbl.commands.edit_release

Edit-release command that updates existing GitHub Release notes by extracting the matching version section from CHANGELOG.md or the versioned release file for dev nodes.

#_read_release_description

python
def _read_release_description(project_dir, version)

Read description from a versioned release file (vX.Y.Z.toml).

Dev node projects have no CHANGELOG.md, so release notes come from the versioned release file instead. Returns the bump type as a minimal description, or a placeholder if the file doesn't exist.

#run_cmd

python
def run_cmd(args, flags, project_root)

Update GitHub Release notes from the changelog entry for a version.

If no version is given, detects the current version from the project's primary target. Reads the changelog entry and updates the GitHub Release.

In monorepo mode, uses the project's monorepo tag format and reads CHANGELOG.md from the project subdirectory. Dev node projects (no CHANGELOG/) read from the versioned release file instead.

Args:

  • args: Positional args; optional first element is the version.
  • flags: dict with key dry-run.
  • project_root: Path to the project root directory, or None for cwd.