common-python-tasks 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

common_python_tasks/github.py

@@ -89,7 +89,39 @@ def get_github_token() -> str | None:
     Returns:
         The GitHub token from `GITHUB_TOKEN` or `GH_TOKEN`, or `None` if unset.
     """
-    return (os.getenv("GITHUB_TOKEN") or os.getenv("GH_TOKEN") or "").strip() or None
+    token = (os.getenv("GITHUB_TOKEN") or os.getenv("GH_TOKEN") or "").strip()
+    if token:
+        return token
+
+    try:
+        result = utils.run_command(
+            ["gh", "auth", "token"],
+            capture_output=True,
+            acceptable_returncodes={0, 1},
+        )
+    except FileNotFoundError:
+        LOGGER.warning(
+            "GitHub CLI not installed; cannot retrieve token via `gh auth token`"
+        )
+        return None
+
+    if result is None:
+        return None
+
+    if result.returncode != 0:
+        stderr = (result.stderr or "").strip()
+        message = "Failed to retrieve GitHub token via `gh auth token`"
+        if stderr:
+            message += f": {stderr}"
+        LOGGER.warning(message)
+        return None
+
+    token = (result.stdout or "").strip()
+    if not token:
+        LOGGER.warning("`gh auth token` returned an empty token")
+        return None
+
+    return token
 
 
 def get_github_api_base_url() -> str:

common_python_tasks/tasks.py

@@ -112,6 +112,8 @@ def _script(
 
 tasks.script = _script
 
+NO_PROMPT_ENV_VAR = "COMMON_PYTHON_TASKS_NO_PROMPT"
+
 
 def _should_update_release_changelog() -> bool:
     from common_python_tasks.env import env_truthy
@@ -119,6 +121,39 @@ def _should_update_release_changelog() -> bool:
     return env_truthy("RELEASE_UPDATE_CHANGELOG")
 
 
+def _confirm_release_with_uncommitted_changes(dirty_files: list[Path]) -> bool:
+    preview = ", ".join(str(path) for path in dirty_files[:5])
+    if len(dirty_files) > 5:
+        preview = f"{preview}, ... and {len(dirty_files) - 5} more"
+
+    LOGGER.warning("Repository has uncommitted changes: %s", preview)
+    try:
+        response = input("Proceed with release anyway? [y/N]: ").strip().lower()
+    except (EOFError, OSError):
+        return False
+    return response in {"y", "yes"}
+
+
+def _resolve_allow_dirty_release(dirty_files: list[Path]) -> bool:
+    from common_python_tasks.utils import fatal
+
+    if not dirty_files:
+        return False
+
+    if os.getenv(NO_PROMPT_ENV_VAR) == "1":
+        LOGGER.warning(
+            "Proceeding with release despite uncommitted changes because %s=1",
+            NO_PROMPT_ENV_VAR,
+        )
+        return True
+
+    if _confirm_release_with_uncommitted_changes(dirty_files):
+        return True
+
+    fatal("Aborted due to uncommitted changes.")
+    return False
+
+
 def _update_release_changelog(release_tag: str, dry_run: bool = False) -> None:
     from common_python_tasks.utils import prepend_changelog, run_command
 
@@ -884,6 +919,7 @@ def bump_version(
     *,
     stage: str | None = None,
     dry_run: bool = False,
+    allow_dirty: bool = False,
 ) -> str:
     """Bump the project version.
 
@@ -892,6 +928,7 @@ def bump_version(
             `auto` to infer the bump from git history using git-cliff.
         stage: Optional pre-release stage to apply: `alpha`, `beta`, or `rc`.
         dry_run: If `True`, print what would happen without making changes.
+        allow_dirty: If `True`, allow version bumping with uncommitted changes.
 
     Returns:
         The new version string that was/would be set.
@@ -909,7 +946,7 @@ def bump_version(
 
     ensure_on_default_branch()
 
-    if get_dirty_files():
+    if get_dirty_files() and not allow_dirty:
         fatal(
             "Repository has uncommitted changes. "
             "Please commit or stash changes before bumping version."
@@ -960,6 +997,7 @@ def _run_release_flow(
     from common_python_tasks.git import (
         build_release_hook_environment,
         ensure_on_default_branch,
+        get_dirty_files,
     )
     from common_python_tasks.utils import (
         log_dry_run,
@@ -971,7 +1009,10 @@ def _run_release_flow(
     post_script = post_script or os.getenv("RELEASE_POST_SCRIPT")
 
     ensure_on_default_branch()
+    allow_dirty = _resolve_allow_dirty_release(get_dirty_files())
     hook_env = build_release_hook_environment(component, normalized_stage, dry_run)
+    if allow_dirty:
+        hook_env[NO_PROMPT_ENV_VAR] = "1"
     if pre_script:
         run_command(["sh", "-lc", pre_script], env=hook_env, dry_run=False)
 
@@ -987,6 +1028,7 @@ def _run_release_flow(
         component=hook_env["RELEASE_COMPONENT"],
         stage=normalized_stage,
         dry_run=dry_run,
+        allow_dirty=allow_dirty,
     )
     if dry_run:
         log_dry_run("Would push tags to origin")

{common_python_tasks-0.1.0.dist-info → common_python_tasks-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: common-python-tasks
-Version: 0.1.0
+Version: 0.2.0
 Summary: Opinionated Poe the Poet tasks for Python package development.
 License-Expression: MIT
 License-File: LICENSE
@@ -23,7 +23,7 @@ Requires-Dist: git-cliff (>=2.12.0,<3.0.0)
 Requires-Dist: isort (>=8.0.1,<9.0.0)
 Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
 Requires-Dist: poethepoet-tasks (>=0.3.0,<0.4.0)
-Requires-Dist: pytest (>=9.0.1,<10.0.0)
+Requires-Dist: pytest (>=9.0.3,<10.0.0)
 Requires-Dist: pytest-cov (>=7.0.0,<8.0.0)
 Requires-Dist: tomlkit (>=0.13.3,<0.14.0)
 Project-URL: Homepage, http://github.com/ci-sourcerer/common-python-tasks
@@ -50,7 +50,7 @@ curl -sSL https://api.github.com/repos/ci-sourcerer/common-python-tasks/contents
 To install a specific release, set the environment variable `COMMON_PYTHON_TASKS_VERSION`.
 
 ```shell
-COMMON_PYTHON_TASKS_VERSION=0.1.0 \
+COMMON_PYTHON_TASKS_VERSION=0.2.0 \
   sh -c "$(curl -sSL https://api.github.com/repos/ci-sourcerer/common-python-tasks/contents/scripts/add-common-python-tasks.sh | jq -r '.content' | base64 -d)"
 ```
 
@@ -71,9 +71,9 @@ There's no real reason to run the automated script; I just like automating every
     ```toml
     [project]
     name = "my-awesome-project"
-    version = "0.1.0"
+    version = "0.2.0"
     dependencies = [
-        "common-python-tasks==0.1.0",  # Always pin to a specific version
+        "common-python-tasks==0.2.0",  # Always pin to a specific version
     ]
 
     [tool.poe]
@@ -287,8 +287,8 @@ By default, `tasks()` exposes the common task set. You can still include or excl
 ```toml
 [project]
 name = "simple-cli-tool"
-version = "0.1.0"
-dependencies = ["common-python-tasks==0.1.0"]
+version = "0.2.0"
+dependencies = ["common-python-tasks==0.2.0"]
 
 [tool.poe]
 include_script = "common_python_tasks:tasks()"
@@ -301,8 +301,8 @@ Available tasks: common defaults such as `format`, `lint`, `test`, and `build`.
 ```toml
 [project]
 name = "containerized-app"
-version = "0.1.0"
-dependencies = ["common-python-tasks==0.1.0"]
+version = "0.2.0"
+dependencies = ["common-python-tasks==0.2.0"]
 
 [tool.poe]
 include_script = "common_python_tasks:tasks(include_tags=['common', 'containers'])"
@@ -319,7 +319,7 @@ Available tasks: All tasks including `build-image` and `push-image`.
 ```toml
 [project]
 name = "custom-test-setup"
-dependencies = ["common-python-tasks==0.1.0"]
+dependencies = ["common-python-tasks==0.2.0"]
 dynamic = ["version"]
 
 [tool.poe]

{common_python_tasks-0.1.0.dist-info → common_python_tasks-0.2.0.dist-info}/RECORD

@@ -17,11 +17,11 @@ common_python_tasks/data/generic/pytest.ini,sha256=RHak5QrLzKHvUBjFmaaiOYFrd_8YB
 common_python_tasks/docker.py,sha256=Pg_fySHIBdjIopme33DYdCYPwCesP9meG5T7xfKr8V8,15378
 common_python_tasks/env.py,sha256=hRGKcad32WjFRfo2d4yQlPrZ7fGpsneIUf-_SxDYt7c,13141
 common_python_tasks/git.py,sha256=XnirI2zNP21-pmxIKFsoG0HWEOmDJ8SzYN4eYWYN6N8,9813
-common_python_tasks/github.py,sha256=EEGem7SCNxyG9suYGEH6tf32yeMbbfA2WadWn2sWqcI,17671
+common_python_tasks/github.py,sha256=IaK-VDN0PrxLIP_ob1n1dTAFdtQHzR_QA5THrrTSuSA,18502
 common_python_tasks/project.py,sha256=I78eQlHeRmVR5WFV_wxGyO_wxNWcYox_UYowUTE4xdU,8914
-common_python_tasks/tasks.py,sha256=LFF-fj_0ZpIgJ0QMsndxfu6rBSTd-NYND_mYbie_uC0,47412
+common_python_tasks/tasks.py,sha256=nfcTyMAbZhfFM2zltWsh_J5AVUAEVT8pET_b685Y3ug,48798
 common_python_tasks/utils.py,sha256=3sNB84F66suu2nUN0mG-SOuJaUctx-p9uHmDAy-Ss0g,11198
-common_python_tasks-0.1.0.dist-info/METADATA,sha256=hELp8ZCIUE64aJxJk9UcprbhzE6eU8aSX73TrSGnXZc,21386
-common_python_tasks-0.1.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
-common_python_tasks-0.1.0.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
-common_python_tasks-0.1.0.dist-info/RECORD,,
+common_python_tasks-0.2.0.dist-info/METADATA,sha256=ctLqOYE7z1r2oDBX07svRYxDE60ECwxeJcPnQc0I224,21386
+common_python_tasks-0.2.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+common_python_tasks-0.2.0.dist-info/licenses/LICENSE,sha256=RsSweM-DyzxFPx38fQOJqHrKyeT9Fiz8rO7yox-fOsw,1070
+common_python_tasks-0.2.0.dist-info/RECORD,,