Merge pull request #72 from robust-python/docs/better-readme

Docs/better readme

Author: 56kyle

.github/workflows/merge-demo-feature.yml

@@ -21,6 +21,7 @@ jobs:
           - "robust-maturin-demo"
     with:
       demo_name: ${{ matrix.demo_name }}
+      branch: ${{ github.ref_name }}
 
   merge-demo-feature:
     name: Merge Demo Feature
@@ -30,6 +31,8 @@ jobs:
         demo_name:
           - "robust-python-demo"
           - "robust-maturin-demo"
+    env:
+      GH_TOKEN: ${{ secrets.DEMO_TOKEN }}
     steps:
       - name: Checkout Template
         uses: actions/checkout@v4
@@ -42,6 +45,7 @@ jobs:
           repository: "${{ github.repository_owner }}/${{ inputs.demo_name }}"
           path: ${{ inputs.demo_name }}
           ref: develop
+          token: ${{ secrets.DEMO_TOKEN }}
 
       - name: Set up uv
         uses: astral-sh/setup-uv@v6

.github/workflows/sync-demos.yml

@@ -1,8 +1,10 @@
 name: sync-demo.yml
 on:
-  pull_request:
-    branches:
-      - develop
+  push:
+    branches-ignore:
+      - "main"
+      - "develop"
+      - "release/*"
 
 jobs:
   update-demo:
@@ -15,3 +17,6 @@ jobs:
           - "robust-maturin-demo"
     with:
       demo_name: ${{ matrix.demo_name }}
+      branch: ${{ github.ref_name }}
+    secrets:
+      DEMO_TOKEN: ${{ secrets.DEMO_TOKEN }}

.github/workflows/update-demo.yml

@@ -5,12 +5,19 @@ on:
       demo_name:
         required: true
         type: string
+      branch:
+        required: true
+        type: string
+    secrets:
+      DEMO_TOKEN:
+        required: true
 
 env:
   COOKIECUTTER_ROBUST_PYTHON__DEMOS_CACHE_FOLDER: ${{ github.workspace }}
   COOKIECUTTER_ROBUST_PYTHON__APP_AUTHOR: ${{ github.repository_owner }}
   ROBUST_PYTHON_DEMO__APP_AUTHOR: ${{ github.repository_owner }}
   ROBUST_MATURIN_DEMO__APP_AUTHOR: ${{ github.repository_owner }}
+  GH_TOKEN: ${{ secrets.DEMO_TOKEN }}
 
 jobs:
   update-demo:
@@ -19,16 +26,24 @@ jobs:
       - name: Checkout Template
         uses: actions/checkout@v4
         with:
+          fetch-depth: 0
           repository: ${{ github.repository }}
           path: "${{ github.workspace }}/cookiecutter-robust-python"
 
+      - name: Configure Git
+        working-directory: "${{ github.workspace }}/cookiecutter-robust-python"
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
       - name: Checkout Demo
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           repository: "${{ github.repository_owner }}/${{ inputs.demo_name }}"
           path: ${{ inputs.demo_name }}
           ref: develop
+          token: ${{ secrets.DEMO_TOKEN }}
 
       - name: Set up uv
         uses: astral-sh/setup-uv@v6
@@ -40,4 +55,4 @@ jobs:
 
       - name: Update Demo
         working-directory: "${{ github.workspace }}/cookiecutter-robust-python"
-        run: "uvx nox -s 'update-demo(${{ inputs.demo_name }})' -- --branch-override ${{ github.head_ref }}"
+        run: "uvx nox -s 'update-demo(${{ inputs.demo_name }})' -- --branch-override ${{ inputs.branch }}"

README.md

@@ -50,6 +50,7 @@ def update_demo(
     demo_name: str = get_demo_name(add_rust_extension=add_rust_extension)
     demo_path: Path = demos_cache_folder / demo_name
 
+    typer.secho(f"template:\n\tcurrent_branch: {get_current_branch()}\n\tcurrent_commit: {get_current_commit()}")
     if branch_override is not None:
         typer.secho(f"Overriding current branch name for demo reference. Using '{branch_override}' instead.")
         desired_branch_name: str = branch_override
@@ -76,6 +77,7 @@ def update_demo(
 
     typer.secho(f"Updating demo project at {demo_path=}.", fg="yellow")
     with work_in(demo_path):
+        typer.secho(f"demo:\n\tcurrent_branch: {get_current_branch()}\n\tcurrent_commit: {get_current_commit()}")
         if get_current_branch() != desired_branch_name:
             git("checkout", "-b", desired_branch_name, DEMO.develop_branch)
 
@@ -146,8 +148,10 @@ def _create_demo_pr(demo_path: Path, branch: str, commit_start: str) -> None:
     """Creates a PR to merge the given branch into develop."""
     gh("repo", "set-default", f"{DEMO.app_author}/{DEMO.app_name}")
     search_results: subprocess.CompletedProcess = gh("pr", "list", "--state", "open", "--search", branch)
-    if "no pull requests match your search" not in search_results.stdout:
-        typer.secho(f"Skipping PR creation due to existing PR found for branch {branch}")
+
+    if search_results.returncode == 0:
+        url: str = _get_pr_url(branch=branch)
+        typer.secho(f"Skipping PR creation due to existing PR found for branch {branch} at {url}")
         return
 
     body: str = _get_demo_feature_pr_body(demo_path=demo_path, commit_start=commit_start)
@@ -160,6 +164,16 @@ def _create_demo_pr(demo_path: Path, branch: str, commit_start: str) -> None:
         "--repo": f"{DEMO.app_author}/{DEMO.app_name}",
     }
     gh("pr", "create", *itertools.chain.from_iterable(pr_kwargs.items()))
+    url: str = _get_pr_url(branch=branch)
+    typer.secho(f"Created PR for branch '{branch}' at '{url}'.")
+
+
+def _get_pr_url(branch: str) -> str:
+    """Returns the url of the current branch's PR."""
+    result: subprocess.CompletedProcess = gh("pr", "view", branch, "--json", "url", "--jq", ".url")
+    if result.returncode != 0:
+        raise ValueError(f"Failed to find a PR URL for branch {branch}.")
+    return result.stdout.strip()
 
 
 def _get_demo_feature_pr_body(demo_path: Path, commit_start: str) -> str:

docs/_static/pin.svg

@@ -131,6 +131,7 @@ def require_clean_and_up_to_date_demo_repo(demo_path: Path) -> None:
     try:
         with work_in(demo_path):
             git("fetch")
+            git("fetch", "origin", f"{DEMO.main_branch}:{DEMO.main_branch}")
             git("status", "--porcelain")
             validate_is_synced_ancestor(ancestor=DEMO.main_branch, descendent=DEMO.develop_branch)
     except Exception as e: