docs(site): show release version and github stars by jdx · Pull Request #872 · jdx/hk

jdx · 2026-04-25T14:36:34Z

Summary

read the latest site release label from Cargo.toml and show it as the releases nav item
add a GitHub star counter to the VitePress social nav, matching the existing aube/mise pattern

Validation

npm run docs:build in /home/jdx/src/hk-release-version/docs

Note: local git hooks were skipped for commit/push because the fresh worktree hook config could not evaluate pkl/Builtins.pkl; the targeted docs build passed.

This PR was generated by Codex.

Note

Low Risk
Low risk docs-only changes, but adds build-time parsing of Cargo.toml and an optional GitHub API call that could affect docs builds if environment/network assumptions change.

Overview
Updates the VitePress docs nav to show the current release label (e.g. vX.Y.Z) by parsing Cargo.toml at build time, replacing the static “Releases” text.

Adds an optional GitHub star counter: stars.data.ts can fetch stargazers_count from the GitHub API (gated by env vars/tokens and tolerant of offline/rate limits), and the theme injects/stylizes a .star-count badge onto the GitHub social link using a MutationObserver for late-rendered DOM.

^{Reviewed by Cursor Bugbot for commit 7235569. Bugbot is set up for automated code reviews on this repo. Configure here.}

gemini-code-assist

Code Review

This pull request automates the version display in the documentation by reading the version from Cargo.toml and introduces a dynamic GitHub star count badge in the social links. Feedback was provided to optimize the DOM manipulation logic for the star count, suggesting the use of querySelectorAll and a more focused MutationObserver scope to improve performance and ensure the badge appears in all navigation contexts.

gemini-code-assist · 2026-04-25T14:38:01Z

+      const addStarCount = () => {
+        const githubLink = document.querySelector(
+          '.VPSocialLinks a[href*="github.com/jdx/hk"]',
+        )
+        if (githubLink && !githubLink.querySelector('.star-count')) {
+          const starBadge = document.createElement('span')
+          starBadge.className = 'star-count'
+          starBadge.textContent = starsData.stars
+          starBadge.title = 'GitHub Stars'
+          githubLink.appendChild(starBadge)
+        }
+      }
+
+      addStarCount()
+      setTimeout(addStarCount, 100)
+      const observer = new MutationObserver(addStarCount)
+      observer.observe(document.body, { childList: true, subtree: true })


Using MutationObserver on document.body with subtree: true can have a negative impact on performance as it triggers on every DOM change across the entire page. Additionally, document.querySelector only targets the first matching element, which might miss the social links in the mobile navigation if both desktop and mobile navs are present in the DOM.

Consider using querySelectorAll to update all instances and narrowing the observer's scope to the navigation bar (.VPNav) for better efficiency. The setTimeout is also likely redundant if the observer is correctly configured.

const addStarCount = () => { const githubLinks = document.querySelectorAll( '.VPSocialLinks a[href*="github.com/jdx/hk"]', ) githubLinks.forEach((githubLink) => { if (!githubLink.querySelector('.star-count')) { const starBadge = document.createElement('span') starBadge.className = 'star-count' starBadge.textContent = starsData.stars starBadge.title = 'GitHub Stars' githubLink.appendChild(starBadge) } }) } addStarCount() const nav = document.querySelector('.VPNav') const observer = new MutationObserver(addStarCount) observer.observe(nav || document.body, { childList: true, subtree: true })

greptile-apps · 2026-04-25T14:38:35Z

Greptile Summary

This PR updates the VitePress docs to surface two pieces of repo metadata: the nav bar now shows the current release version parsed from Cargo.toml at build time, and a GitHub star counter badge is appended to the social nav link at runtime via a MutationObserver. Both previously-flagged issues (hardcoded fallback stars and the uncleared observer) are resolved in this revision.

Confidence Score: 5/5

Safe to merge — docs-only change with no runtime or security impact on the tool itself.

No P0 or P1 issues found. Both previously flagged concerns (hardcoded fallback stars and uncleared MutationObserver) are resolved. The build-time Cargo.toml parsing has a graceful fallback, the GitHub API fetch is opt-in with a silent-catch, and the observer lifecycle is properly managed with onUnmounted.

No files require special attention.

Important Files Changed

Filename	Overview
docs/.vitepress/config.mts	Reads Cargo.toml at build time with a regex to extract version; gracefully falls back to '0.0.0' with a warning if the match fails. Path resolution and regex are correct for a standard (non-workspace) root Cargo.toml.
docs/.vitepress/stars.data.ts	New VitePress data loader; fetches stargazers_count from GitHub API when a token or opt-in env var is present, returns empty string otherwise so no badge is shown in fallback mode. 10s AbortSignal timeout and silent catch make builds robust.
docs/.vitepress/theme/index.ts	Injects star-count badge via MutationObserver in onMounted; observer is properly cleaned up in onUnmounted. Previous leak issue is resolved.
docs/.vitepress/theme/style.css	Adds CSS for the star-count badge positioning and hover colour; uses !important to override VitePress defaults, hidden on small screens. Scoped tightly to the GitHub social link anchor.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Build["Build Time (config.mts)"]
        A[Read Cargo.toml] --> B{Regex match /package/ version}
        B -- match --> C[latestVersion = semver]
        B -- no match --> D[latestVersion = '0.0.0' + console.warn]
        C --> E[Nav: vX.Y.Z → GitHub releases]
    end
    subgraph Stars["Build Time (stars.data.ts)"]
        F{GITHUB_TOKEN / UPDATE_GITHUB_STARS?}
        F -- yes --> G[GET api.github.com/repos/jdx/hk]
        G -- ok --> H[stars = stargazers_count]
        G -- error/timeout --> I[stars = 0 / empty string]
        F -- no --> I
        H --> J[return formatStars]
        I --> K[return empty string]
    end
    subgraph Runtime["Runtime (theme/index.ts)"]
        L[onMounted] --> M{starsData.stars not empty?}
        M -- yes --> N[querySelectorAll .VPSocialLinks]
        N -- found --> O[Append .star-count span]
        N -- not found --> P[MutationObserver watches .VPNav]
        P -- element appears --> O
        M -- empty --> Q[Observer watches but returns false immediately]
        O --> R[observer.disconnect]
        S[onUnmounted] --> T[observer?.disconnect]
    end

_{Reviews (2): Last reviewed commit: "docs(site): address release nav feedback" | Re-trigger Greptile}

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 7235569. Configure here.}

cursor · 2026-04-25T15:10:50Z

+      observer = new MutationObserver(() => {
+        if (addStarCount()) observer?.disconnect()
+      })
+      observer.observe(document.querySelector('.VPNav') || document.body, { childList: true, subtree: true })


MutationObserver runs forever when stars data is empty

Low Severity

When starsData.stars is "" (the common case when no GITHUB_TOKEN or UPDATE_GITHUB_STARS env var is set during build), addStarCount() returns false immediately. The if (addStarCount()) return check at the outer level then falls through and creates a MutationObserver that can never disconnect — because every subsequent call to addStarCount() also returns false. This leaves a subtree observer permanently attached to .VPNav or document.body, firing its callback on every DOM mutation to no effect.

Additional Locations (1)

docs/.vitepress/theme/index.ts#L19-L21

^{Reviewed by Cursor Bugbot for commit 7235569. Configure here.}

@jdx

### 🐛 Bug Fixes - **(builtins)** silence pklr deprecation warnings on Builtins.pkl load by [@jdx](https://github.com/jdx) in [#880](#880) - **(ci)** serialize docs lint step by [@jdx](https://github.com/jdx) in [#874](#874) - **(config)** include main pkl path in cache fresh files by [@jdx](https://github.com/jdx) in [#879](#879) - **(docs)** stack banner message and link on mobile by [@jdx](https://github.com/jdx) in [#865](#865) - **(docs)** pin banner close button to top-right corner on mobile by [@jdx](https://github.com/jdx) in [#867](#867) ### 📚 Documentation - **(site)** show release version and github stars by [@jdx](https://github.com/jdx) in [#872](#872) ### 🔍 Other Changes - add pr-closer workflow by [@jdx](https://github.com/jdx) in [#876](#876) ### 📦️ Dependency Updates - bump communique 1.0.3 → 1.0.4 by [@jdx](https://github.com/jdx) in [#868](#868) - update anthropics/claude-code-action digest to 2da6cfa by [@renovate[bot]](https://github.com/renovate[bot]) in [#869](#869) - update anthropics/claude-code-action digest to 567fe95 by [@renovate[bot]](https://github.com/renovate[bot]) in [#870](#870) - bump communique to 1.1.2 by [@jdx](https://github.com/jdx) in [#875](#875)  --- > [!NOTE] > <sup>[Cursor Bugbot](https://cursor.com/bugbot) is generating a summary for commit 62ff432. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup>  Co-authored-by: mise-en-dev <123107610+mise-en-dev@users.noreply.github.com>

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [hk](https://github.com/jdx/hk) | minor | `1.43.0` → `1.45.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.45.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1450---2026-05-04) [Compare Source](jdx/hk@v1.44.3...v1.45.0) ##### 🚀 Features - **(builtins)** add `buildifier` format and lint built-ins by [@plx](https://github.com/plx) in [#896](jdx/hk#896) ##### 🐛 Bug Fixes - **(step)** only auto-batch when rendered command exceeds ARG\_MAX by [@jdx](https://github.com/jdx) in [#901](jdx/hk#901) ##### 📚 Documentation - thank Namespace for GitHub Actions runner support by [@jdx](https://github.com/jdx) in [#895](jdx/hk#895) ##### 🔍 Other Changes - **(ci)** use !cancelled() instead of always() for final job by [@jdx](https://github.com/jdx) in [#906](jdx/hk#906) - **(docs)** remove shrill.en.dev analytics script by [@jdx](https://github.com/jdx) in [#903](jdx/hk#903) - remove rust-cache from release jobs by [@jdx](https://github.com/jdx) in [#893](jdx/hk#893) - invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical by [@jdx](https://github.com/jdx) in [#905](jdx/hk#905) - set dev profile debug to 1 by [@jdx](https://github.com/jdx) in [#907](jdx/hk#907) ##### 📦️ Dependency Updates - update anthropics/claude-code-action digest to [`fefa07e`](jdx/hk@fefa07e) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#897](jdx/hk#897) - update jdx/mise-action digest to [`1648a78`](jdx/hk@1648a78) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#898](jdx/hk#898) - update apple-actions/import-codesign-certs action to v7 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#900](jdx/hk#900) - update autofix-ci/action action to v1.3.4 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#899](jdx/hk#899) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#908](jdx/hk#908) ##### New Contributors - [@plx](https://github.com/plx) made their first contribution in [#896](jdx/hk#896) ### [`v1.44.3`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1443---2026-04-30) [Compare Source](jdx/hk@v1.44.2...v1.44.3) ##### 🐛 Bug Fixes - **(hook)** do not stage fixes when fail\_on\_fix=true by [@jdx](https://github.com/jdx) in [#892](jdx/hk#892) - use site domain for plausible data-domain by [@jdx](https://github.com/jdx) in [#886](jdx/hk#886) - make text-mode progress output usable in CI by [@jdx](https://github.com/jdx) in [#890](jdx/hk#890) ##### 📚 Documentation - prefix GitHub star count with ★ glyph by [@jdx](https://github.com/jdx) in [#883](jdx/hk#883) ##### 🔍 Other Changes - **(release)** dedupe sponsor section in release notes by [@jdx](https://github.com/jdx) in [#881](jdx/hk#881) - switch analytics from gtm/goatcounter to plausible by [@jdx](https://github.com/jdx) in [#885](jdx/hk#885) - migrate to namespace.so runners by [@jdx](https://github.com/jdx) in [#891](jdx/hk#891) ### [`v1.44.2`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1442---2026-04-26) [Compare Source](jdx/hk@v1.44.1...v1.44.2) ##### 🐛 Bug Fixes - **(builtins)** silence pklr deprecation warnings on Builtins.pkl load by [@jdx](https://github.com/jdx) in [#880](jdx/hk#880) - **(ci)** serialize docs lint step by [@jdx](https://github.com/jdx) in [#874](jdx/hk#874) - **(config)** include main pkl path in cache fresh files by [@jdx](https://github.com/jdx) in [#879](jdx/hk#879) - **(docs)** stack banner message and link on mobile by [@jdx](https://github.com/jdx) in [#865](jdx/hk#865) - **(docs)** pin banner close button to top-right corner on mobile by [@jdx](https://github.com/jdx) in [#867](jdx/hk#867) ##### 📚 Documentation - **(site)** show release version and github stars by [@jdx](https://github.com/jdx) in [#872](jdx/hk#872) ##### 🔍 Other Changes - add pr-closer workflow by [@jdx](https://github.com/jdx) in [#876](jdx/hk#876) ##### 📦️ Dependency Updates - bump communique 1.0.3 → 1.0.4 by [@jdx](https://github.com/jdx) in [#868](jdx/hk#868) - update anthropics/claude-code-action digest to [`2da6cfa`](jdx/hk@2da6cfa) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#869](jdx/hk#869) - update anthropics/claude-code-action digest to [`567fe95`](jdx/hk@567fe95) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#870](jdx/hk#870) - bump communique to 1.1.2 by [@jdx](https://github.com/jdx) in [#875](jdx/hk#875) ### [`v1.44.1`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1441---2026-04-24) [Compare Source](jdx/hk@v1.44.0...v1.44.1) ##### 🐛 Bug Fixes - **(git)** skip untracked scan when HK\_STASH\_UNTRACKED=false by [@jdx](https://github.com/jdx) in [#861](jdx/hk#861) - **(run)** add post-commit and pre-rebase subcommands by [@jdx](https://github.com/jdx) in [#858](jdx/hk#858) ##### 📚 Documentation - **(install)** recommend global hooks as primary setup path by [@jdx](https://github.com/jdx) in [#855](jdx/hk#855) - add cross-site announcement banner by [@jdx](https://github.com/jdx) in [#857](jdx/hk#857) - respect banner expires field by [@jdx](https://github.com/jdx) in [#862](jdx/hk#862) ##### 🔍 Other Changes - vendor bats test helpers instead of git submodules by [@jdx](https://github.com/jdx) in [#859](jdx/hk#859) ##### 📦️ Dependency Updates - bump communique to 1.0.3 by [@jdx](https://github.com/jdx) in [#863](jdx/hk#863) - update anthropics/claude-code-action digest to [`e58dfa5`](jdx/hk@e58dfa5) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#864](jdx/hk#864) ### [`v1.44.0`](https://github.com/jdx/hk/blob/HEAD/CHANGELOG.md#1440---2026-04-23) [Compare Source](jdx/hk@v1.43.0...v1.44.0) ##### 🚀 Features - **(check)** implement --plan, --why, and --json by [@jdx](https://github.com/jdx) in [#848](jdx/hk#848) - **(cocogitto)** add cocogitto conventional commits config to hk builtin config by [@hituzi-no-sippo](https://github.com/hituzi-no-sippo) in [#838](jdx/hk#838) - **(git)** support GIT\_DIR/GIT\_WORK\_TREE for bare-repo dotfile managers by [@jdx](https://github.com/jdx) in [#847](jdx/hk#847) - **(install)** use Git 2.54 config-based hooks with --global support by [@jdx](https://github.com/jdx) in [#853](jdx/hk#853) ##### 🐛 Bug Fixes - use text progress in CI by [@jdx](https://github.com/jdx) in [#845](jdx/hk#845) ##### 📚 Documentation - generalize agent guidelines by [@jdx](https://github.com/jdx) in [#846](jdx/hk#846) - add releases nav and aube lock by [@jdx](https://github.com/jdx) in [#849](jdx/hk#849) ##### 🔍 Other Changes - **(release)** append en.dev sponsor blurb to release notes by [@jdx](https://github.com/jdx) in [#854](jdx/hk#854) - bump communique to 1.0.1 by [@jdx](https://github.com/jdx) in [#850](jdx/hk#850) ##### 📦️ Dependency Updates - update actions-rust-lang/setup-rust-toolchain digest to [`2b1f5e9`](jdx/hk@2b1f5e9) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#832](jdx/hk#832) - update anthropics/claude-code-action digest to [`c3d45e8`](jdx/hk@c3d45e8) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#833](jdx/hk#833) - update rust crate tokio to v1.52.1 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#834](jdx/hk#834) - update actions/upload-pages-artifact action to v5 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#835](jdx/hk#835) - update taiki-e/upload-rust-binary-action digest to [`f0d45ae`](jdx/hk@f0d45ae) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#839](jdx/hk#839) - update rust crate clx to v2 by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#836](jdx/hk#836) - update anthropics/claude-code-action digest to [`0d2971c`](jdx/hk@0d2971c) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#841](jdx/hk#841) - update anthropics/claude-code-action digest to [`38ec876`](jdx/hk@38ec876) by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#842](jdx/hk#842) - lock file maintenance by [@renovate\[bot\]](https://github.com/renovate\[bot]) in [#851](jdx/hk#851) </details> --- ### Configuration 📅 **Schedule**: (UTC) - 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 [Mend Renovate](https://github.com/renovatebot/renovate).

docs(site): show release version and github stars

9b090e3

gemini-code-assist Bot reviewed Apr 25, 2026

View reviewed changes

greptile-apps Bot reviewed Apr 25, 2026

View reviewed changes

Comment thread docs/.vitepress/theme/index.ts Outdated

Comment thread docs/.vitepress/stars.data.ts Outdated

cursor Bot reviewed Apr 25, 2026

View reviewed changes

Comment thread docs/.vitepress/theme/index.ts Outdated

jdx marked this pull request as ready for review April 25, 2026 15:01

docs(site): address release nav feedback

7235569

cursor Bot reviewed Apr 25, 2026

View reviewed changes

jdx merged commit 9a50d39 into main Apr 25, 2026
34 of 36 checks passed

jdx deleted the codex/release-version-title branch April 25, 2026 17:07

jdx mentioned this pull request Apr 25, 2026

chore: release v1.44.2 #866

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(site): show release version and github stars#872

docs(site): show release version and github stars#872
jdx merged 2 commits intomainfrom
codex/release-version-title

jdx commented Apr 25, 2026 •

edited by cursor Bot

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Apr 25, 2026

Uh oh!

greptile-apps Bot commented Apr 25, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Uh oh!

cursor Bot Apr 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

jdx commented Apr 25, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Apr 25, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Flowchart

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot Apr 25, 2026

Choose a reason for hiding this comment

MutationObserver runs forever when stars data is empty

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jdx commented Apr 25, 2026 •

edited by cursor Bot

Loading

greptile-apps Bot commented Apr 25, 2026 •

edited

Loading