rlsbl v0.51.0 /rlsbl.commands.yank
Updated
On this page

Yank command that deprecates a past release via soft yank (pre-release flag with notice) or hard yank (delete), with monorepo tag format support.

#rlsbl.commands.yank

#rlsbl.commands.yank

Yank command that marks a past release as deprecated, either soft (flag as pre-release and prepend a deprecation notice) or hard (delete the GitHub release while preserving the git tag).

#run_cmd

python
def run_cmd(args, flags, project_root)

Yank a past GitHub Release.

Default (soft): mark as pre-release and prepend a deprecation notice. With --hard: delete the GitHub Release (git tag is preserved).

In monorepo mode, uses the project's monorepo tag format (e.g. [email protected]) instead of the plain v1.2.3 tag.

Args:

  • args: Positional args; first element is the version to yank.
  • flags: dict with keys dry-run, yes, hard, reason, use.
  • project_root: Path to the project root directory, or None for cwd.

#_hard_yank

python
def _hard_yank(tag, dry_run)

Delete the GitHub Release and its assets. The git tag stays.

#_soft_yank

python
def _soft_yank(tag, reason, use, dry_run)

Mark as pre-release and prepend a deprecation notice to the release body.

#_build_notice

python
def _build_notice(reason, use)

Build the deprecation notice string from optional reason and use fields.