GitHub Integration

releasio integrates seamlessly with GitHub for automated releases.

---

Features

• GitHub Actions

  ---

  Automate releases with native GitHub Actions support

  Actions Guide

• Trusted Publishing

  ---

  Publish to PyPI without API tokens using OIDC

  Setup Guide

• Release Assets

  ---

  Upload files to GitHub releases automatically

  Assets Guide

---

Quick Setup

1. Create Workflow

.github/workflows/release.yml

name: Release

on:
  push:
    branches: [main]

permissions:
  contents: write
  pull-requests: write
  id-token: write

jobs:
  release-pr:
    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 }}

  release:
    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
          github-token: ${{ secrets.GITHUB_TOKEN }}

2. Enable Repository Settings

1. Go to Settings → Actions → General
2. Enable "Allow GitHub Actions to create and approve pull requests"

3. Set Up Trusted Publishing (Optional)

1. Go to PyPI → Your project → Publishing
2. Add a trusted publisher with your repository details

That's it! Push to main and releasio handles the rest.

---

How It Works

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant D as Developer
    participant G as GitHub
    participant R as releasio
    participant P as PyPI

    D->>G: Push to main
    G->>R: Trigger release-pr
    R->>G: Create Release PR
    D->>G: Merge PR
    G->>R: Trigger release
    R->>G: Create tag & release
    R->>P: Publish package