docs: Don't suggest configuring hk in config env by thejcannon · Pull Request #424 · jdx/hk

thejcannon · 2025-11-18T20:25:37Z

I was trying to disable staging, and since config stage doesn't exist, tried to configure via env, but that didn't work either.

I poked through src/settings.rs and didn't see anything obvious that suggests this is supposed to work.

So, removing the misleading section from the docs (alternatively we could make this supported, but this doesn't preclude that)

thejcannon · 2025-11-18T20:25:47Z

Here's a diff to prove what I was trying to do:

diff --git a/test/stage_setting.bats b/test/stage_setting.bats
index 351fd0e..fa81d3f 100644
--- a/test/stage_setting.bats
+++ b/test/stage_setting.bats
@@ -149,3 +149,51 @@ EOF
     assert_success
     assert_output --partial "?? generated.txt"
 }
+
+@test "config env HK_STAGE respected" {
+    cat <<EOF > hk.pkl
+amends "$PKL_PATH/Config.pkl"
+env {
+    ["HK_STAGE"] = "0"
+}
+hooks {
+    ["pre-commit"] {
+        fix = true
+        stash = "git"
+        steps {
+            ["generate"] {
+                glob = "src/*.txt"
+                stage = List("generated.txt")
+                fix = "echo 'generated content' > generated.txt"
+            }
+        }
+    }
+}
+EOF
+
+mkdir -p src
+    echo "original content" > src/test.txt
+
+    git add hk.pkl src/test.txt
+    git commit -m "init"
+    hk install
+
+    # Make a change to trigger the hook
+    echo "modified content" > src/test.txt
+    git add src/test.txt
+
+    hk run pre-commit
+
+    # Verify that src/test.txt is still staged
+    run git diff --name-only --cached
+    assert_success
+    assert_output --partial "src/test.txt"
+
+    # Verify that generated.txt is NOT staged
+    refute_output --partial "generated.txt"
+
+    # Verify that generated.txt exists but is untracked
+    run git status --porcelain --untracked-files=all
+    assert_success
+    assert_output --partial "?? generated.txt"
+}

@thejcannon

## [1.21.1](https://github.com/jdx/hk/compare/v1.21.0..v1.21.1) - 2025-11-19 ### 🐛 Bug Fixes - **(ruff)** Make `ruff` respect user config `exclude` by [@thejcannon](https://github.com/thejcannon) in [#421](#421) - **(ruff_format)** Pass `--force-exclude` to `ruff format` (as well) by [@thejcannon](https://github.com/thejcannon) in [#428](#428) - Fix --check docstring by [@thejcannon](https://github.com/thejcannon) in [#423](#423) - Configuration Read Support YML File Extension by [@hcoona](https://github.com/hcoona) in [#427](#427) - treat check_list_files stderr as informational, not an error by [@jdx](https://github.com/jdx) in [#425](#425) ### 🚜 Refactor - Enable `trailing-whitespace` in this repo by [@thejcannon](https://github.com/thejcannon) in [#429](#429) ### 📚 Documentation - Don't suggest configuring hk in config env by [@thejcannon](https://github.com/thejcannon) in [#424](#424) ### New Contributors - @thejcannon made their first contribution in [#428](#428) - @hcoona made their first contribution in [#427](#427)  --- > [!NOTE] > Bump to 1.21.1 with updated docs/templates, corrected --check help text, and minor dependency refresh. > > - **Release/versioning**: > - Bump crate to `1.21.1` in `Cargo.toml`, `Cargo.lock`, `hk.usage.kdl`, and docs (`docs/cli/index.md`, `docs/cli/commands.json`). > - Update all `pkl` package URLs and examples to `v1.21.1` (init template in `src/cli/init.rs`, docs, examples). > - Add `CHANGELOG.md` entry for `1.21.1`. > - **CLI/help text**: > - Fix `--check` help to “Run check command instead of fix command” across CLI specs and docs (`docs/cli/*`, `hk.usage.kdl`, `docs/cli/commands.json`). > - **Code/messages**: > - Refresh Pkl error example version in `src/config.rs`. > - **Dependencies**: > - Update `clap`/`clap_builder` to `4.5.52` and `unit-prefix` to `0.5.2` in `Cargo.lock`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 3ed921a. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>  Co-authored-by: mise-en-dev <[email protected]>

docs: Don't suggest configuring hk in config env

a6d4e14

jdx merged commit dfdae31 into jdx:main Nov 18, 2025
15 checks passed

jdx mentioned this pull request Nov 18, 2025

chore: release v1.21.1 #422

Merged

thejcannon deleted the jcannon/cant-config-hk-via-pkl-env branch November 19, 2025 01:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

docs: Don't suggest configuring hk in config env#424

docs: Don't suggest configuring hk in config env#424
jdx merged 1 commit intojdx:mainfrom
thejcannon:jcannon/cant-config-hk-via-pkl-env

thejcannon commented Nov 18, 2025 •

edited

Loading

Uh oh!

thejcannon commented Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

thejcannon commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thejcannon commented Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

thejcannon commented Nov 18, 2025 •

edited

Loading