docs: add recommended setup section to mise integration by timothysparg · Pull Request #780 · jdx/hk

timothysparg · 2026-03-29T11:43:22Z

Add a "Recommended Setup" section to the mise integration docs based on the discussion in #754.

Additionally fixed a broken link forHK_MISE and added an info section about what activating HK_MISE will do

gemini-code-assist

Code Review

This pull request updates the mise integration documentation by correcting a configuration link, adding an informational block about the HK_MISE environment variable, and providing a recommended setup example using mise.toml. There are no review comments to address, and I have no feedback to provide.

greptile-apps · 2026-03-29T11:45:48Z

Greptile Summary

This is a docs-only PR that improves the mise_integration.md page with three additions: a corrected anchor link for HK_MISE (from /configuration#hk-mise to the correct /environment_variables#hk-mise), a new :::info callout explaining the effect of HK_MISE=1, and a new "Recommended Setup" section showing a complete mise.toml example that uses the postinstall hook to automate hk install --mise for the whole team.

Link fix: The original link was broken (/configuration#hk-mise) since HK_MISE is documented under environment_variables.md, not configuration.md. The fix is correct.
Info admonition: Accurately describes the mise x wrapping behavior from environment_variables.md.
Recommended Setup: The mise.toml example is well-structured and matches the pattern discussed in issue Idiomatic mise integration setup #754. Minor note: hk install --mise in the postinstall hook is redundant when HK_MISE = 1 is already set in the same file's [env] section, since the env var makes --mise automatic. It is not incorrect, just slightly inconsistent with how the env var's effect is explained."

Confidence Score: 5/5

Safe to merge — documentation-only change with accurate content and a valid link fix.

All changes are documentation. The link fix is correct, the admonition is accurate, and the recommended setup example is valid. The only finding is a P2 style note about a redundant --mise flag.

No files require special attention.

Important Files Changed

Filename	Overview
docs/mise_integration.md	Fixes a broken anchor link (`/configuration#hk-mise` → `/environment_variables#hk-mise`), adds an `:::info` admonition explaining `HK_MISE=1` behavior, and adds a "Recommended Setup" section with a `mise.toml` example using `postinstall` to auto-install hooks.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer joins project] --> B[Clones repo]
    B --> C[Runs `mise install`]
    C --> D[mise installs hk + all tools from mise.toml]
    D --> E[mise runs postinstall hook]
    E --> F[`hk install --mise` executed]
    F --> G[Git hooks written with `mise x` wrapper]
    G --> H[Developer runs git commit]
    H --> I[Git hook fires]
    I --> J[`mise x hk run pre-commit` executed]
    J --> K[mise env + tools loaded automatically]
    K --> L[hk runs configured checks]

_{Reviews (1): Last reviewed commit: "docs: add recommended setup section to m..." | Re-trigger Greptile}

greptile-apps · 2026-03-29T11:45:52Z

+
+[hooks]
+# Automatically install/update hooks when tools are installed
+postinstall = "hk install --mise"


--mise flag redundant with HK_MISE = 1

Since HK_MISE = 1 is already declared in the [env] section of the same mise.toml, running hk install in the postinstall hook will automatically use mise x (as documented in environment_variables.md: "When installing hooks with hk install, hk will use mise x to execute hooks"). The explicit --mise flag is therefore redundant in this context.

While it's not incorrect—it makes the intent clear for readers—you may want to simplify to hk install to demonstrate that HK_MISE = 1 takes effect, or add a comment noting it's equivalent.

Suggested change

postinstall = "hk install --mise"

postinstall = "hk install"

_{Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!}

@hituzi-no-sippo

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [hk](https://github.com/jdx/hk) | minor | `1.39.0` → `1.40.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.40.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1400---2026-04-01) [Compare Source](jdx/hk@v1.39.0...v1.40.0) ##### 🚀 Features - **(betterleaks)** add betterleaks config to hk builtin config by [@hituzi-no-sippo](https://github.com/hituzi-no-sippo) in [#750](jdx/hk#750) - **(builtins)** add google-java-format to builtins by [@timothysparg](https://github.com/timothysparg) in [#777](jdx/hk#777) - **(builtins)** add dclint to builtins by [@timothysparg](https://github.com/timothysparg) in [#779](jdx/hk#779) - **(config)** set default value for exclude to List() by [@timothysparg](https://github.com/timothysparg) in [#781](jdx/hk#781) - **(core)** add required field to prevent unconfigured steps from running by [@timothysparg](https://github.com/timothysparg) in [#785](jdx/hk#785) - **(gitleaks)** add gitleaks config to hk builtin config by [@hituzi-no-sippo](https://github.com/hituzi-no-sippo) in [#749](jdx/hk#749) - **(mdschema)** add mdschema config to hk builtin config by [@hituzi-no-sippo](https://github.com/hituzi-no-sippo) in [#748](jdx/hk#748) - **(pkl)** add pklr as opt-in pkl backend by [@jdx](https://github.com/jdx) in [#769](jdx/hk#769) - add pklr as opt-in pkl backend by [@jdx](https://github.com/jdx) in [#768](jdx/hk#768) ##### 🐛 Bug Fixes - **(docs)** replace invalid /latest/ pkl package URIs with versioned format by [@jdx](https://github.com/jdx) in [#770](jdx/hk#770) - **(stage)** do not stage pre-existing untracked files by [@jdx](https://github.com/jdx) in [#788](jdx/hk#788) ##### 📚 Documentation - add benchmarks page and reproducible benchmark suite by [@jdx](https://github.com/jdx) in [#766](jdx/hk#766) - add recommended setup section to mise integration by [@timothysparg](https://github.com/timothysparg) in [#780](jdx/hk#780) ##### 📦️ Dependency Updates - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#762](jdx/hk#762) - update rust crate pklr to 0.4 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#776](jdx/hk#776) - update apple-actions/import-codesign-certs digest to [`fe74d46`](jdx/hk@fe74d46) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#774](jdx/hk#774) - update anthropics/claude-code-action digest to [`094bd24`](jdx/hk@094bd24) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#773](jdx/hk#773) - update taiki-e/upload-rust-binary-action digest to [`0e34102`](jdx/hk@0e34102) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#775](jdx/hk#775) - bump usage to 3.2.0 and pkl to 0.31.1, add windows platforms by [@jdx](https://github.com/jdx) in [#787](jdx/hk#787) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#786](jdx/hk#786) ##### New Contributors - [@timothysparg](https://github.com/timothysparg) made their first contribution in [#781](jdx/hk#781) </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. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

docs: add recommended setup section to mise integration

3327f9e

gemini-code-assist Bot reviewed Mar 29, 2026

View reviewed changes

greptile-apps Bot reviewed Mar 29, 2026

View reviewed changes

jdx merged commit b9f0e02 into jdx:main Mar 31, 2026
22 checks passed

jdx mentioned this pull request Mar 31, 2026

chore: release v1.40.0 #763

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add recommended setup section to mise integration#780

docs: add recommended setup section to mise integration#780
jdx merged 1 commit intojdx:mainfrom
timothysparg:docs/mise-recommended-setup

timothysparg commented Mar 29, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

greptile-apps Bot commented Mar 29, 2026

Uh oh!

greptile-apps Bot Mar 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

timothysparg commented Mar 29, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

greptile-apps Bot commented Mar 29, 2026

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

greptile-apps Bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants