rlsbl v0.113.0 /rlsbl.commands.deprecate
Updated
On this page

Deprecate command that marks a past release as deprecated by setting the GitHub pre-release flag and prepending a deprecation notice to the release notes.

#rlsbl.commands.deprecate

#rlsbl.commands.deprecate

Deprecate command that marks a past release as deprecated by setting the GitHub pre-release flag and prepending a deprecation notice to the release notes.

#run_cmd

python
def run_cmd(args, flags, project_root)

Deprecate a past GitHub Release.

Marks the release as pre-release and prepends a deprecation notice to the release body.

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 deprecate.
  • flags: dict with keys dry-run, yes, reason, use.
  • project_root: Path to the project root directory, or None for cwd.

#_soft_deprecate

python
def _soft_deprecate(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.

Search