NAME

repomatic prepare-release - Freeze version, changelog and pins for a release

SYNOPSIS

repomatic prepare-release [OPTIONS]

DESCRIPTION

Prepare files for a release or post-release version bump.

This command consolidates all release preparation steps:

- Set release date in changelog (replaces "(unreleased)" with today's date).
- Set release date in citation.cff.
- Update changelog comparison URL from "...main" to "...v{version}".
- Remove the "[!WARNING]" development warning block from changelog.
- Optionally update workflow URLs to use versioned tag.

When running in GitHub Actions, --update-workflows is auto-detected:
it defaults to True when $GITHUB_REPOSITORY matches the canonical
workflows repository (kdeldycke/repomatic).

For post-release (after the release commit), use --post-release to retarget workflow URLs back to the default branch.

OPTIONS

--changelog FILE

Path to the changelog file. Defaults to the configured changelog.location.

--citation FILE

Path to the citation file.

--workflow-dir DIRECTORY

Path to the GitHub workflows directory.

--default-branch TEXT

Name of the default branch for workflow URL updates.

--update-workflows / --no-update-workflows

Update workflow URLs to use versioned tag instead of default branch. Defaults to True when $GITHUB_REPOSITORY is the canonical workflows repo.

--post-release

Run post-release steps (retarget workflow URLs to default branch).

--help / -h

Show this message and exit.

ENVIRONMENT

PREPARE_RELEASE_CHANGELOG_PATH

Path to the changelog file. Defaults to the configured changelog.location.

PREPARE_RELEASE_CITATION_PATH

Path to the citation file.

PREPARE_RELEASE_WORKFLOW_DIR

Path to the GitHub workflows directory.

PREPARE_RELEASE_DEFAULT_BRANCH

Name of the default branch for workflow URL updates.

PREPARE_RELEASE_UPDATE_WORKFLOWS

Update workflow URLs to use versioned tag instead of default branch. Defaults to True when $GITHUB_REPOSITORY is the canonical workflows repo.

PREPARE_RELEASE_POST_RELEASE

Run post-release steps (retarget workflow URLs to default branch).

PREPARE_RELEASE__CLICK_DEFAULT_HELP

Show this message and exit.

EXIT STATUS

0

Success.

1

A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).

2

A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

Prepare release (changelog + citation)

repomatic prepare\-release

Post-release: retarget workflows to main branch

repomatic prepare\-release \-\-post\-release

AUTHORS

Kevin Deldycke