@mizchi/actrun 0.18.0 → 0.22.0

package/README.md

@@ -74,6 +74,17 @@ nix_packages = ["python312", "jq"]
 # Container runtime: docker, podman, container, lima, nerdctl
 container_runtime = "docker"
 
+# Include uncommitted changes in worktree/tmp workspace
+# include_dirty = true
+
+# Default local GitHub context when `--event` is omitted
+# [local_context]
+# repository = "owner/repo"
+# ref_name = "main"
+# before_rev = "HEAD^"
+# after_rev = "HEAD"
+# actor = "your-name"
+
 # Override actions with local commands
 # [override."actions/setup-node"]
 # run = "echo 'using local node' && node --version"
@@ -83,6 +94,8 @@ container_runtime = "docker"
 # patterns = ["src/**", "package.json"]
 ```
 
+When `--event` is omitted, actrun auto-detects `github.repository`, `github.ref_name`, `github.sha`, and `github.actor` from the local git repository when possible. Use `[local_context]` only when you need to pin or override those values. See [Local GitHub Context](docs/local-context.md) for precedence and examples.
+
 CLI flags always override `actrun.toml` settings. See [Cheatsheet](docs/cheatsheet.md) for quick reference and [Advanced Workflow](docs/advanced-workflow.md) for details.
 
 ## CLI Reference
@@ -212,6 +225,7 @@ actrun cache prune --key <key>                         # Delete cache entry
 | `--container-runtime <name>` | Container runtime: `docker`, `podman`, `container`, `lima`, `nerdctl` |
 | `--affected [base]` | Only run if files matching patterns changed (see below) |
 | `--retry` | Re-run only failed jobs from the latest run |
+| `--include-dirty` | Include uncommitted changes in worktree/tmp workspace |
 | `--json` | JSON output for read commands and `--dry-run` |
 
 ## Affected Runs