ci: add release.yml to publish to pypi and release to github (by "ap bump --release" or "ap release") using github workflows

Author: softwareentrepreneer

.env.example

@@ -1,3 +1,2 @@
-UV_PUBLISH_TOKEN=...  # Your PyPI API token for publishing to pypi.org
 AP_AUTO_SYNC=0        # if = 1, Auto-sync pyproject.toml+afterpython.toml-> myst.yml files
 AP_MOLAB_BADGE=1      # if = 1, auto-add molab badges to jupyter notebooks

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release to PyPI and GitHub
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on all version tags (v0.1.0, v0.1.0rc1, v0.1.0.dev4, etc.)
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Required for creating GitHub releases
+      id-token: write  # Required for PyPI trusted publishing
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+
+      - name: Determine if pre-release
+        id: check_prerelease
+        run: |
+          # Extract version from tag (remove 'v' prefix)
+          VERSION="${GITHUB_REF_NAME#v}"
+
+          # Check if this is a pre-release or dev version
+          # Matches: dev, rc, alpha, beta, a1, b2 (but not 'stable-version')
+          if [[ "$VERSION" =~ (dev|rc|alpha|beta|a[0-9]+|b[0-9]+) ]]; then
+            echo "prerelease=true" >> $GITHUB_OUTPUT
+          else
+            echo "prerelease=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          generate_release_notes: false
+          prerelease: ${{ steps.check_prerelease.outputs.prerelease }}
+          files: dist/*  # Attach built packages (wheel + sdist)

afterpython/cli/commands/bump.py

@@ -37,6 +37,18 @@ def bump(ctx, release: bool, pre: bool):
     # bump using cz bump's default behavior
     if release:
         subprocess.run(["ap", "cz", "bump", *ctx.args])
+
+        # Get the new version after bump
+        metadata = read_metadata()
+        new_version = metadata.version
+        if new_version is None:
+            raise click.ClickException("Unable to read version after bump")
+
+        tag = f"v{new_version}"
+
+        # Auto-push the specific tag to trigger release workflow
+        click.echo(f"\n🚀 Pushing tag {tag} to trigger release workflow...")
+        subprocess.run(["git", "push", "origin", tag])
     else:
         metadata = read_metadata()
         version = metadata.version

afterpython/cli/commands/release.py

@@ -0,0 +1,67 @@
+import subprocess
+
+import click
+
+
+@click.command()
+@click.option(
+    "--force",
+    "-f",
+    is_flag=True,
+    help="Force release even for dev versions (not recommended)",
+)
+def release(force: bool):
+    """Manually trigger a release by pushing the current version tag.
+
+    This command is used to manually publish dev versions or pre-releases to PyPI
+    and create GitHub releases. It pushes the tag for the current version, which
+    triggers the GitHub Actions release workflow.
+
+    By default, releases are only allowed for non-dev versions (stable releases
+    and pre-releases like rc, alpha, beta). Use --force to release dev versions.
+
+    The release workflow will:
+    - Run tests in CI
+    - Publish to PyPI (if tests pass)
+    - Create a GitHub release (if tests pass)
+
+    Examples:
+        ap bump --pre      # Bump to pre-release (e.g., 0.1.0rc1)
+        ap release         # Push tag → triggers release workflow
+
+        ap bump            # Bump dev version (e.g., 0.1.0.dev4)
+        ap release --force # Push tag → triggers release workflow (dev version)
+    """
+    from afterpython.tools.pyproject import read_metadata
+
+    # Get current version from pyproject.toml
+    metadata = read_metadata()
+    version = metadata.version
+
+    if version is None:
+        raise click.ClickException("Unable to read version from pyproject.toml")
+
+    # Check if this is a dev version
+    if version.is_devrelease and not force:
+        raise click.ClickException(
+            f"Cannot release dev version '{version}' without --force flag.\n"
+            f"Dev versions are typically not published to PyPI.\n"
+            f"Use 'ap bump --release' for stable releases (auto-releases),\n"
+            f"or 'ap bump --pre' then 'ap release' for pre-releases,\n"
+            f"or 'ap release --force' to release this dev version anyway."
+        )
+
+    tag = f"v{version}"
+
+    click.echo(f"🏷️  Pushing tag {tag} to trigger release workflow...")
+    result = subprocess.run(["git", "push", "origin", tag], capture_output=False)
+
+    if result.returncode != 0:
+        click.echo(f"\n❌ Failed to push tag (exit code {result.returncode})", err=True)
+        raise click.ClickException("Git push failed")
+
+    click.echo(f"✅ Tag {tag} pushed successfully")
+    click.echo("\n📋 Check GitHub Actions to see the release workflow progress.")
+
+    if version.is_devrelease:
+        click.echo("   ⚠️  Warning: Publishing a dev version to PyPI and GitHub")

afterpython/cli/main.py

@@ -22,6 +22,7 @@
 from afterpython.cli.commands.commitizen import commitizen
 from afterpython.cli.commands.commit import commit
 from afterpython.cli.commands.bump import bump
+from afterpython.cli.commands.release import release
 
 
 @tui(command="tui", help="Open terminal UI")
@@ -67,3 +68,4 @@ def afterpython_group(ctx):
 afterpython_group.add_command(commitizen, name="cz")
 afterpython_group.add_command(commit)
 afterpython_group.add_command(bump)
+afterpython_group.add_command(release)

afterpython/cz.toml

@@ -1,7 +1,7 @@
 [tool.commitizen]
 name = "cz_conventional_commits"
 # name = "cz_customize"
-tag_format = "$version"
+tag_format = "v$version"
 version_scheme = "pep440"
 version_provider = "uv"
 update_changelog_on_bump = false

afterpython/doc/references/roadmap.md

@@ -7,4 +7,5 @@ This roadmap is tentative and subject to change
 - full-text search engine using pagefind
 - AI chatbot like kapa.ai using WebLLM
 - incremental build, only build changed content (for `ap dev`)
+- integrate with `git-cliff` for changelog generation
 - integrate with `pixi`, supports `conda install`

afterpython/tools/commitizen.py

@@ -5,7 +5,7 @@
     "tool": {
         "commitizen": {
             "name": "cz_conventional_commits",
-            "tag_format": "$version",
+            "tag_format": "v$version",
             "version_scheme": "pep440",
             "version_provider": "uv",
             "update_changelog_on_bump": False,