docs: add releases nav and aube lock by jdx · Pull Request #593 · jdx/usage

jdx · 2026-04-19T16:32:09Z

Summary

add a Releases link to the docs nav
switch docs install/build commands from pnpm to aube via mise
replace pnpm-lock.yaml with aube-lock.yaml and ignore .aube/

Validation

git diff --check
mise x aube@latest node@24 -- aube run docs:build

Note

Medium Risk
Medium risk because it changes the GitHub Pages build toolchain (switching from pnpm/setup-node to mise/aube), which can break docs CI/deploy if tool resolution or lockfiles differ.

Overview
Docs build/deploy now runs via aube + mise instead of pnpm. The Pages workflow drops pnpm/setup-node steps and runs aube install + aube run docs:build, and the local docs:dev task is updated similarly.

Dependency locking changes. Adds aube-lock.yaml, ignores .aube/, and updates mise config/lock to include aube (and node), shifting the pinned toolchain for docs.

Docs UI tweak. Adds a Releases nav link in docs/.vitepress/config.mts pointing to GitHub releases.

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

socket-security · 2026-04-19T16:32:31Z

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action	Severity	Alert (click "▶" to expand/collapse)
Warn		License policy violation: npm `typescript` License: LicenseRef-W3C-Community-Final-Specification-Agreement - The applicable license policy does not permit this license (5) (package/ThirdPartyNoticeText.txt) From: `?` → `npm/@fig/[email protected]` → `npm/[email protected]` → `npm/[email protected]` ℹ Read more on: This package \| This alert \| What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `[email protected]`. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/[email protected]`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

codecov · 2026-04-19T16:34:28Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.04%. Comparing base (5ba9170) to head (e733e37).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #593   +/-   ##
=======================================
  Coverage   79.04%   79.04%           
=======================================
  Files          48       48           
  Lines        7235     7235           
  Branches     7235     7235           
=======================================
  Hits         5719     5719           
  Misses       1141     1141           
  Partials      375      375

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

greptile-apps · 2026-04-19T16:34:31Z

Greptile Summary

This PR migrates the docs toolchain from pnpm to aube (via mise), adds a "Releases" nav link to the VitePress config, and updates all related automation (CI workflow, release script, lockfile, gitignore) consistently.

Confidence Score: 5/5

Safe to merge — all changes are consistent tooling migration with no functional regressions.

All findings are P2 (stale pnpm entry in mise.lock). The migration from pnpm to aube is applied consistently across workflow, lockfile, gitignore, mise config, and release scripts. No logic errors or security concerns found.

mise.lock — contains a leftover pnpm tool entry that should be cleaned up.

Important Files Changed

Filename	Overview
.github/workflows/docs.yml	Replaced pnpm/setup-node steps with jdx/mise-action; updated install and build commands to use aube. Logic is correct — mise-action installs all tools from mise.toml including aube before the install step runs.
docs/.vitepress/config.mts	Added a "Releases" nav link pointing to the GitHub releases page. No issues.
mise.toml	Added aube = "latest" to tools; docs:dev task now uses aube. Consistent with the rest of the migration.
mise.lock	Added aube v1.0.0-beta.5 lock entry, but still contains a stale pnpm entry that was removed from mise.toml.
tasks/release-plz	Updated to run aube update and stage aube-lock.yaml instead of pnpm-lock.yaml. Release automation is correctly updated.
aube-lock.yaml	New lockfile replacing pnpm-lock.yaml; auto-generated by aube.
.gitignore	Added .aube/ to the ignore list, consistent with ignoring package-manager cache directories.

Sequence Diagram

sequenceDiagram
    participant GH as GitHub Actions
    participant mise as jdx/mise-action
    participant aube as aube (pkg mgr)
    participant vp as VitePress

    GH->>mise: Install tools (mise.toml incl. aube + node)
    mise-->>GH: Tools ready
    GH->>aube: aube install (reads aube-lock.yaml)
    aube-->>GH: node_modules ready
    GH->>aube: aube run docs:build
    aube->>vp: Build docs site
    vp-->>GH: dist/ output
    GH->>GH: Upload artifact & deploy to Pages

_{Reviews (1): Last reviewed commit: "[autofix.ci] apply automated fixes" | Re-trigger Greptile}

greptile-apps · 2026-04-19T16:34:35Z

 [[tools.pnpm]]
 version = "10.29.3"
 backend = "aqua:pnpm/pnpm"
-"platforms.linux-x64" = { checksum = "sha256:2fc98db127c611be0c110af11b5b72759f7d736893dddc81df73b7b59b30f15a", url = "https://github.com/pnpm/pnpm/releases/download/v10.29.3/pnpm-linux-x64"}
-"platforms.macos-arm64" = { checksum = "sha256:a248c56b0ab20443e18d0c8ee3207c6c564ee342bd3fc8694b3569a060cecece", url = "https://github.com/pnpm/pnpm/releases/download/v10.29.3/pnpm-macos-arm64"}
+
+[tools.pnpm."platforms.linux-x64"]
+checksum = "sha256:2fc98db127c611be0c110af11b5b72759f7d736893dddc81df73b7b59b30f15a"
+url = "https://github.com/pnpm/pnpm/releases/download/v10.29.3/pnpm-linux-x64"
+
+[tools.pnpm."platforms.macos-arm64"]
+checksum = "sha256:a248c56b0ab20443e18d0c8ee3207c6c564ee342bd3fc8694b3569a060cecece"
+url = "https://github.com/pnpm/pnpm/releases/download/v10.29.3/pnpm-macos-arm64"


Stale pnpm entry in mise.lock

pnpm was removed from mise.toml tools but its lock entry remains. This orphaned entry won't cause a build failure, but it could be confusing and may cause mise to warn or behave unexpectedly. Running mise lock after removing the tool from mise.toml should clean this up.

gemini-code-assist

Code Review

This pull request transitions the project from pnpm to aube for dependency management, adding aube-lock.yaml and updating task configurations in mise.toml and release scripts. Documentation navigation is also enhanced with a link to the releases page. Feedback was provided to remove the directory constraint on the docs:dev task to ensure aube correctly identifies the root configuration.

gemini-code-assist · 2026-04-19T16:36:46Z

 dir = 'docs'
-run = 'npm run docs:dev'
+run = 'aube install && aube run docs:dev'


The docs:dev task is configured with dir = 'docs', but the package.json and aube-lock.yaml files are located in the project root. Running aube install and aube run from within the docs/ subdirectory may cause aube to miss the root configuration or create an unintended local lockfile. Since the validation steps in the PR description run from the root, it is recommended to remove the dir setting for this task.

Suggested change

dir = 'docs'

run = 'npm run docs:dev'

run = 'aube install && aube run docs:dev'

run = 'aube install && aube run docs:dev'

@david-hamilton-glean

docs: add releases nav and aube lock

e68eb7e

[autofix.ci] apply automated fixes

e733e37

greptile-apps Bot reviewed Apr 19, 2026

View reviewed changes

gemini-code-assist Bot reviewed Apr 19, 2026

View reviewed changes

jdx merged commit c14ffbf into main Apr 19, 2026
9 checks passed

jdx deleted the codex/docs-releases-aube branch April 19, 2026 17:14

mise-en-dev mentioned this pull request Apr 19, 2026

chore: release v3.2.1 #564

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add releases nav and aube lock#593

docs: add releases nav and aube lock#593
jdx merged 2 commits intomainfrom
codex/docs-releases-aube

jdx commented Apr 19, 2026 •

edited by cursor Bot

Loading

Uh oh!

socket-security Bot commented Apr 19, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Apr 19, 2026 •

edited

Loading

Uh oh!

greptile-apps Bot commented Apr 19, 2026

Uh oh!

greptile-apps Bot Apr 19, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Apr 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

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

Uh oh!

Summary

Validation

Uh oh!

socket-security Bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Apr 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

greptile-apps Bot commented Apr 19, 2026

Greptile Summary

Confidence Score: 5/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps Bot Apr 19, 2026

Choose a reason for hiding this comment

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 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jdx commented Apr 19, 2026 •

edited by cursor Bot

Loading

socket-security Bot commented Apr 19, 2026 •

edited

Loading

codecov Bot commented Apr 19, 2026 •

edited

Loading