feat: add deployment workflow for github actions

Author: softwareentrepreneer

.github/workflows/deploy.yml

@@ -0,0 +1,71 @@
+name: Deploy Project Website to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main  # Deploy when pushing to main branch
+    paths:
+      # Trigger deployment only when content or website files change
+      - 'afterpython/doc/**'
+      - 'afterpython/blog/**'
+      - 'afterpython/tutorial/**'
+      - 'afterpython/example/**'
+      - 'afterpython/guide/**'
+      - 'afterpython/static/**'
+      - 'afterpython/_website/**'
+      - 'afterpython/authors.yml'
+      - 'afterpython/faq.yml'
+      - '.github/workflows/deploy.yml'
+  workflow_dispatch:  # Allow manual deployment from Actions tab
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    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: Install afterpython
+        run: uv pip install --system afterpython
+
+      - name: Build website
+        run: ap build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './afterpython/_website/build'
+
+  deploy:
+    environment:
+      name: github-pages
+      # This will dynamically generate the deployment URL
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

afterpython/cli/commands/build.py

@@ -133,6 +133,14 @@ def build(ctx, dev: bool, execute: bool):
     Use --execute to execute Jupyter notebooks for all content types.
     """
     from afterpython.utils import has_content_for_myst
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and myst's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["myst", "build"],
+        show_underlying=True,
+    )
 
     paths = ctx.obj["paths"]
     prebuild()
@@ -147,7 +155,7 @@ def build(ctx, dev: bool, execute: bool):
             content_path = paths.afterpython_path / content_type
             if not has_content_for_myst(content_path):
                 click.echo(f"Skipping {content_type}/ (no content files found)")
-                return
+                continue
 
             click.echo(f"Building {content_type}/...")
             # NOTE: needs to set BASE_URL so that the project website can link to the content pages correctly at e.g. localhost:5173/doc

afterpython/cli/commands/bump.py

@@ -30,6 +30,14 @@ def bump(ctx, release: bool, pre: bool):
     Use --release to bump to next stable version (cz bump default behavior).
     """
     from afterpython.tools.pyproject import read_metadata
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and commitizen's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["cz", "bump"],
+        show_underlying=True,
+    )
 
     if release and pre:
         raise click.ClickException("Only one of --release or --pre can be specified")
@@ -38,6 +46,10 @@ def bump(ctx, release: bool, pre: bool):
     if release:
         subprocess.run(["ap", "cz", "bump", *ctx.args])
 
+        # Skip tag push if this is a dry run
+        if "--dry-run" in ctx.args:
+            return
+
         # Get the new version after bump
         metadata = read_metadata()
         new_version = metadata.version

afterpython/cli/commands/check.py

@@ -14,6 +14,15 @@
 @click.pass_context
 def check(ctx):
     """Simple wrapper for ruff check for convenience, always use the afterpython/ruff.toml if it exists"""
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and ruff's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["ruff", "check"],
+        show_underlying=True,
+    )
+
     paths = ctx.obj["paths"]
     ruff_toml = paths.afterpython_path / "ruff.toml"
     if ruff_toml.exists():

afterpython/cli/commands/clean.py

@@ -29,6 +29,15 @@
 )
 def clean(ctx, all: bool):
     """Clean the build directory"""
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and myst's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["myst", "clean"],
+        show_underlying=True,
+    )
+
     paths = ctx.obj["paths"]
     node_env: NodeEnv = find_node_env()
 

afterpython/cli/commands/commit.py

@@ -17,6 +17,15 @@
 )
 def commit(ctx, no_cz: bool):
     """Run 'cz commit'"""
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and commitizen's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["cz", "commit"],
+        show_underlying=True,
+    )
+
     if not no_cz:
         subprocess.run(["ap", "cz", "commit", *ctx.args])
     else:

afterpython/cli/commands/commitizen.py

@@ -14,6 +14,15 @@
 @click.pass_context
 def commitizen(ctx):
     """Run commitizen"""
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and commitizen's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["cz"],
+        show_underlying=True,
+    )
+
     paths = ctx.obj["paths"]
     cz_toml_path = paths.afterpython_path / "cz.toml"
     result = subprocess.run(

afterpython/cli/commands/dev.py

@@ -50,6 +50,15 @@ def dev(ctx, all: bool, execute: bool, no_website: bool):
     with custom Vite options in the afterpython/_website directory.
     """
 
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and myst's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["myst", "start"],
+        show_underlying=True,
+    )
+
     # Track all MyST processes for cleanup
     myst_processes = []
 

afterpython/cli/commands/format.py

@@ -14,6 +14,15 @@
 @click.pass_context
 def format(ctx):
     """Simple wrapper for ruff format for convenience"""
+    from afterpython.utils import handle_passthrough_help
+
+    # Show both our options and ruff's help and exit
+    handle_passthrough_help(
+        ctx,
+        ["ruff", "format"],
+        show_underlying=True,
+    )
+
     result = subprocess.run(["ruff", "format", *ctx.args], check=False)
     if result.returncode != 0:
         raise Exit(result.returncode)

afterpython/cli/commands/init.py

@@ -55,7 +55,10 @@ def init(ctx):
     from afterpython.tools.myst import init_myst
     from afterpython.tools.pre_commit import init_pre_commit
     from afterpython.tools.commitizen import init_commitizen
-    from afterpython.tools.github_actions import init_release_workflow
+    from afterpython.tools.github_actions import (
+        init_release_workflow,
+        init_deploy_workflow,
+    )
 
     paths = ctx.obj["paths"]
     click.echo("Initializing afterpython...")
@@ -91,3 +94,5 @@ def init(ctx):
     ):
         init_commitizen()
         init_release_workflow()
+
+    init_deploy_workflow()