gha-utils 4.8.4__py3-none-any.whl → 4.10.0__py3-none-any.whl

gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.8.4"
+__version__ = "4.10.0"

gha_utils/metadata.py

@@ -22,6 +22,7 @@ The following variables are `printed to the environment file
 ```text
 new_commits=346ce664f055fbd042a25ee0b7e96702e95 6f27db47612aaee06fdf08744b09a9f5f6c2
 release_commits=6f27db47612aaee06fdf08744b09a9f5f6c2
+gitignore_exists=true
 python_files=".github/update_mailmap.py" ".github/metadata.py" "setup.py"
 doc_files="changelog.md" "readme.md" "docs/license.md"
 is_python_project=true
@@ -614,6 +615,10 @@ class Metadata:
             flags=NODIR | GLOBSTAR | DOTGLOB | GLOBTILDE | BRACE | FOLLOW | NEGATE,
         )
 
+    @cached_property
+    def gitignore_exists(self) -> bool:
+        return Path(".gitignore").is_file()
+
     @cached_property
     def python_files(self) -> Iterator[str]:
         """Returns a list of python files."""
@@ -996,14 +1001,16 @@ class Metadata:
         # https://snarky.ca/webassembly-and-its-platform-targets/
         matrix: dict[str, list[Any]] = {
             "entry_point": [],
-            # Run the compilation only the latest supported version of each OS.
+            # Run the compilation only on the latest supported version of each OS.
             # The exception is macOS, as macos-15 is arm64 and macos-13 is x64, so we
             # need both to target the two architectures.
+            # XXX In the future arm64 versions of Ubuntu and Windows might be supported:
+            # https://github.com/actions/runner-images/issues/10820
             "os": [
-                "ubuntu-24.04",
+                "ubuntu-24.04",  # x64
                 "macos-15",  # arm64
                 "macos-13",  # x64
-                "windows-2022",
+                "windows-2022",  # x64
             ],
             # Extra parameters.
             "include": [],
@@ -1208,6 +1215,7 @@ class Metadata:
         metadata: dict[str, Any] = {
             "new_commits": self.new_commits_hash,
             "release_commits": self.release_commits_hash,
+            "gitignore_exists": self.gitignore_exists,
             "python_files": self.python_files,
             "doc_files": self.doc_files,
             "is_python_project": self.is_python_project,

{gha_utils-4.8.4.dist-info → gha_utils-4.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: gha-utils
-Version: 4.8.4
+Version: 4.10.0
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows
@@ -94,9 +94,48 @@ Nothing is done behind your back. A PR is created every time a change is propose
 
 ## `gha-utils` CLI
 
+### Ad-hoc execution
+
+Thanks to `uv`, you can install and run `gha-utils` in one command, without polluting your system:
+
+```shell-session
+$ uvx gha-utils
+Installed 45 packages in 45ms
+Usage: gha-utils [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --time / --no-time        Measure and print elapsed execution time.  [default:
+                            no-time]
+  --color, --ansi / --no-color, --no-ansi
+                            Strip out all colors and all ANSI codes from output.
+                            [default: color]
+  -C, --config CONFIG_PATH  Location of the configuration file. Supports glob
+                            pattern of local path and remote URL.  [default:
+                            ~/Library/Application Support/gha-
+                            utils/*.{toml,yaml,yml,json,ini,xml}]
+  --show-params             Show all CLI parameters, their provenance, defaults
+                            and value, then exit.
+  -v, --verbosity LEVEL     Either CRITICAL, ERROR, WARNING, INFO, DEBUG.
+                            [default: WARNING]
+  --version                 Show the version and exit.
+  -h, --help                Show this message and exit.
+
+Commands:
+  changelog     Maintain a Markdown-formatted changelog
+  mailmap-sync  Update Git's .mailmap file with missing contributors
+  metadata      Output project metadata
+```
+
+```shell-session
+$ uvx gha-utils --version
+gha-utils, version 4.9.0
+```
+
+That's the best way to get started with `gha-utils`, and experiment with its features.
+
 ### Executables
 
-Standalone executables of `gha-utils`'s latest version are available as direct downloads for several platforms and architectures:
+To ease deployment, standalone executables of `gha-utils`'s latest version are available as direct downloads for several platforms and architectures:
 
 | Platform    | `x86_64`                                                                                                                          | `arm64`                                                                                                                           |
 | ----------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
@@ -104,7 +143,9 @@ Standalone executables of `gha-utils`'s latest version are available as direct d
 | **macOS**   | [Download `gha-utils-macos-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-x64.bin)     | [Download `gha-utils-macos-arm64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-arm64.bin) |
 | **Windows** | [Download `gha-utils-windows-x64.exe`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-windows-x64.exe) |                                                                                                                                   |
 
-### Run dev version
+### Development version
+
+To play with the latest development version of `gha-utils`, you can install it directly from the repository:
 
 ```shell-session
 $ git clone https://github.com/kdeldycke/workflows
@@ -112,7 +153,7 @@ $ cd workflows
 $ python -m pip install uv
 $ uv venv
 $ source .venv/bin/activate
-$ uv pip install .
+$ uv sync
 $ uv run -- gha-utils
 ```
 

gha_utils-4.10.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+gha_utils/__init__.py,sha256=5f8Ppp_vpQHlX_tlq24hUmeB4bCMtakF6DyPxS76sJQ,866
+gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
+gha_utils/changelog.py,sha256=oahY88A9FRV14f1JSFKIiYrN_TS7Jo3QlljXqJbeuaE,5892
+gha_utils/cli.py,sha256=1sgNwDQS9vL5eTUjFXWQVYxtV6LTLRyo4kMnl4Joqg4,9175
+gha_utils/mailmap.py,sha256=snSQBn1BDZ21783l4yCkQc3RLIxh5X6QCunFRkDj-24,6301
+gha_utils/metadata.py,sha256=PGIv3Gy8I7RjbgOSn6ZPWsgrMRz8zf6cuPn6A4F6ebY,49482
+gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gha_utils-4.10.0.dist-info/METADATA,sha256=WoSGBLgL0W_ehx-08I8dKVeQW1I9074TqDD748DHEBE,20106
+gha_utils-4.10.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+gha_utils-4.10.0.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
+gha_utils-4.10.0.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
+gha_utils-4.10.0.dist-info/RECORD,,

{gha_utils-4.8.4.dist-info → gha_utils-4.10.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gha_utils-4.8.4.dist-info/RECORD

@@ -1,12 +0,0 @@
-gha_utils/__init__.py,sha256=O1_dwlnipQhaW2LRp3Sq8NkIr7o6aS2JTaIr_xXDJTw,865
-gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
-gha_utils/changelog.py,sha256=oahY88A9FRV14f1JSFKIiYrN_TS7Jo3QlljXqJbeuaE,5892
-gha_utils/cli.py,sha256=1sgNwDQS9vL5eTUjFXWQVYxtV6LTLRyo4kMnl4Joqg4,9175
-gha_utils/mailmap.py,sha256=snSQBn1BDZ21783l4yCkQc3RLIxh5X6QCunFRkDj-24,6301
-gha_utils/metadata.py,sha256=6N_YIARr18gKzDET8B57iFROSQxhzsbhJ9CwahsUM9E,49125
-gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gha_utils-4.8.4.dist-info/METADATA,sha256=d791zTndfI_ltmkEYyYtialH1tkaBWujgfVXFaFmIP0,18466
-gha_utils-4.8.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-gha_utils-4.8.4.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
-gha_utils-4.8.4.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
-gha_utils-4.8.4.dist-info/RECORD,,