releasio release-pr¶

:material-pull-request: Create or update a release pull request with version bump and changelog.

Usage¶

releasio release-pr [PATH] [OPTIONS]

Description¶

The release-pr command automates the release preparation:

Calculates the next version from commits
Updates pyproject.toml and CHANGELOG.md
Commits changes to a release branch
Creates or updates a pull request

This is the recommended way to prepare releases.

Arguments¶

Argument	Type	Default	Description
`PATH`	Path	`.`	Project directory path

Options¶

Option	Description
`--execute`	Actually create the PR (default: dry-run)
`--verbose`	Show detailed output

Examples¶

Preview (Dry-Run)¶

releasio release-pr

Shows what the PR would look like without creating it.

Create the PR¶

releasio release-pr --execute

Example Output

╭─ Release PR ─────────────────────────────────────────────╮
│                                                          │
│  📦 Project: my-project                                  │
│  🔄 Version: 1.2.0 → 1.3.0                               │
│                                                          │
│  ✅ Updated pyproject.toml                               │
│  ✅ Updated CHANGELOG.md                                 │
│  ✅ Created commit                                       │
│  ✅ Pushed to releasio/release                           │
│  ✅ Created PR #42                                       │
│                                                          │
│  🔗 https://github.com/user/repo/pull/42                 │
│                                                          │
╰──────────────────────────────────────────────────────────╯

How It Works¶

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant U as User
    participant R as releasio
    participant G as Git
    participant GH as GitHub

    U->>R: release-pr --execute
    R->>G: Get commits since last tag
    R->>R: Calculate version bump
    R->>G: Create/checkout release branch
    R->>R: Update version & changelog
    R->>G: Commit changes
    R->>G: Push branch
    R->>GH: Create/update PR
    GH-->>U: PR URL

Configuration¶

Customize the release PR in your config:

.releasio.toml

[github]
release_pr_branch = "releasio/release"  # Branch name
release_pr_labels = ["release"]          # PR labels

GitHub Actions¶

Automate release PR creation:

.github/workflows/release.yml

name: Release

on:
  push:
    branches: [main]

jobs:
  release-pr:
    # Skip if this is already a release commit
    if: "!startsWith(github.event.head_commit.message, 'chore(release):')"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: mikeleppane/releasio@v2
        with:
          command: release-pr
          github-token: ${{ secrets.GITHUB_TOKEN }}

Automatic Updates

The action automatically updates the PR when new commits are pushed to main.