Skip to content

Comments

docs: Clarify stash default (behavior)#431

Merged
jdx merged 3 commits intojdx:mainfrom
thejcannon:jcannon/misleading-stash-default
Nov 19, 2025
Merged

docs: Clarify stash default (behavior)#431
jdx merged 3 commits intojdx:mainfrom
thejcannon:jcannon/misleading-stash-default

Conversation

@thejcannon
Copy link
Contributor

  • Added a new test to help demonstrate that the default stashing strategy is to not stash
  • Updated the config docs to reflect that none is the true default of hooks.<HOOK>.stash
  • Similarly, changed the CLI docs to remove "auto" (not a valid value), and also stringified the strings (for clarity)

@jdx jdx merged commit a54ed37 into jdx:main Nov 19, 2025
13 checks passed
@thejcannon thejcannon deleted the jcannon/misleading-stash-default branch November 19, 2025 17:34
@jdx jdx mentioned this pull request Nov 19, 2025
jdx added a commit that referenced this pull request Nov 19, 2025
## [1.22.0](https://github.com/jdx/hk/compare/v1.21.1..v1.22.0) -
2025-11-19

### 🚀 Features

- Add `stdin` to step config by
[@thejcannon](https://github.com/thejcannon) in
[#435](#435)

### 📚 Documentation

- Clarify `stash` default (behavior) by
[@thejcannon](https://github.com/thejcannon) in
[#431](#431)
- Clarify hook fix default by
[@thejcannon](https://github.com/thejcannon) in
[#433](#433)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Bumps to 1.22.0, documents new `Step.stdin`, and updates docs
(including stash default to "auto") and versioned references.
> 
> - **Release**
> - Bump crate/CLI version to `1.22.0` in `Cargo.toml`, `Cargo.lock`,
`hk.usage.kdl`, docs, and generated CLI specs; update init template
(`src/cli/init.rs`) and error hint (`src/config.rs`).
> - **Docs**
> - Add `Step.stdin` configuration to schema/config docs with usage
example.
> - Change `stash` default to `"auto"` and document the `auto` strategy.
> - Update all Pkl import URLs and examples to `v1.22.0`; refresh CLI
docs/version strings.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
7e47865. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: mise-en-dev <[email protected]>
jdx pushed a commit that referenced this pull request Nov 20, 2025
This was removed in #431 but re-introduced
accidentally in
6e0c13e

🤷‍♂️
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Nov 21, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [hk](https://github.com/jdx/hk) | minor | `1.20.0` -> `1.22.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>jdx/hk (hk)</summary>

### [`v1.22.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1220---2025-11-19)

[Compare Source](jdx/hk@v1.21.1...v1.22.0)

##### 🚀 Features

- Add `stdin` to step config by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;435](jdx/hk#435)

##### 🐛 Bug Fixes

- save patch backup files when using git as stash method by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;434](jdx/hk#434)

##### 📚 Documentation

- Clarify `stash` default (behavior) by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;431](jdx/hk#431)
- Clarify hook fix default by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;433](jdx/hk#433)

### [`v1.21.1`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1211---2025-11-19)

[Compare Source](jdx/hk@v1.21.0...v1.21.1)

##### 🐛 Bug Fixes

- **(ruff)** Make `ruff` respect user config `exclude` by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;421](jdx/hk#421)
- **(ruff\_format)** Pass `--force-exclude` to `ruff format` (as well) by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;428](jdx/hk#428)
- Fix --check docstring by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;423](jdx/hk#423)
- Configuration Read Support YML File Extension by [@&#8203;hcoona](https://github.com/hcoona) in [#&#8203;427](jdx/hk#427)
- treat check\_list\_files stderr as informational, not an error by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;425](jdx/hk#425)
- remove trailing whitespace in ruff\_format.pkl by [@&#8203;jdx](https://github.com/jdx) in [9f4abdc](jdx/hk@9f4abdc)

##### 🚜 Refactor

- Enable `trailing-whitespace` in this repo by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;429](jdx/hk#429)

##### 📚 Documentation

- Don't suggest configuring hk in config env by [@&#8203;thejcannon](https://github.com/thejcannon) in [#&#8203;424](jdx/hk#424)

##### New Contributors

- [@&#8203;thejcannon](https://github.com/thejcannon) made their first contribution in [#&#8203;428](jdx/hk#428)
- [@&#8203;hcoona](https://github.com/hcoona) made their first contribution in [#&#8203;427](jdx/hk#427)

### [`v1.21.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1210---2025-11-15)

[Compare Source](jdx/hk@v1.20.0...v1.21.0)

##### 🚀 Features

- **(dprint)** new builtin by [@&#8203;scop](https://github.com/scop) in [#&#8203;402](jdx/hk#402)
- **(mypy,ruff,ruff\_format)** associate with .pyi by [@&#8203;scop](https://github.com/scop) in [#&#8203;404](jdx/hk#404)
- **(prettier)** support Vue files by [@&#8203;minusfive](https://github.com/minusfive) in [#&#8203;388](jdx/hk#388)
- **(terraform,tofu)** include .tftest.hcl in glob by [@&#8203;scop](https://github.com/scop) in [#&#8203;397](jdx/hk#397)
- **(tflint)** add fix command by [@&#8203;scop](https://github.com/scop) in [#&#8203;401](jdx/hk#401)
- **(typos)** new builtin by [@&#8203;scop](https://github.com/scop) in [#&#8203;400](jdx/hk#400)
- use recursive glob patterns in all builtins by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;383](jdx/hk#383)
- shfmt improvements by [@&#8203;scop](https://github.com/scop) in [#&#8203;410](jdx/hk#410)
- add content-based file type matching by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;416](jdx/hk#416)
- add clap-sort unit test and sort CLI flags alphabetically by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;419](jdx/hk#419)
- Add alternate config directory support with tests by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;407](jdx/hk#407)

##### 🐛 Bug Fixes

- **(golangci-lint)** check with --fix=false by [@&#8203;scop](https://github.com/scop) in [#&#8203;399](jdx/hk#399)
- **(shfmt)** don't pass -s by [@&#8203;scop](https://github.com/scop) in [#&#8203;398](jdx/hk#398)
- **(tf\_lint)** don't pass filenames by [@&#8203;scop](https://github.com/scop) in [#&#8203;396](jdx/hk#396)
- Import elixir builtins by [@&#8203;arthurcogo](https://github.com/arthurcogo) in [#&#8203;390](jdx/hk#390)
- Add warning for existing Git hooks path by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;409](jdx/hk#409)
- prevent untracked files from being staged with \<JOB\_FILES> by [@&#8203;jdx](https://github.com/jdx) in [#&#8203;408](jdx/hk#408)

##### 📚 Documentation

- Add Elixir builtins to docs by [@&#8203;arthurcogo](https://github.com/arthurcogo) in [#&#8203;389](jdx/hk#389)
- glossary grammar fix by [@&#8203;scop](https://github.com/scop) in [#&#8203;395](jdx/hk#395)
- fix link to Pkl language docs by [@&#8203;scop](https://github.com/scop) in [#&#8203;394](jdx/hk#394)

##### 📦️ Dependency Updates

- update anthropics/claude-code-action digest to [`8a1c437`](jdx/hk@8a1c437) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;391](jdx/hk#391)
- update jdx/mise-action digest to [`be3be22`](jdx/hk@be3be22) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;392](jdx/hk#392)
- update github artifact actions (major) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;393](jdx/hk#393)
- update rust crate infer to 0.19 by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;418](jdx/hk#418)
- update jdx/mise-action digest to [`9dc7d5d`](jdx/hk@9dc7d5d) by [@&#8203;renovate\[bot\]](https://github.com/renovate\[bot]) in [#&#8203;417](jdx/hk#417)

##### New Contributors

- [@&#8203;scop](https://github.com/scop) made their first contribution in [#&#8203;410](jdx/hk#410)
- [@&#8203;arthurcogo](https://github.com/arthurcogo) made their first contribution in [#&#8203;390](jdx/hk#390)
- [@&#8203;minusfive](https://github.com/minusfive) made their first contribution in [#&#8203;388](jdx/hk#388)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNzMuMSIsInVwZGF0ZWRJblZlciI6IjQxLjE3My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants