Skip to content

docs(tasks): enhance monorepo documentation with tool comparisons#6563

Merged
jdx merged 4 commits intomainfrom
docs/monorepo-tasks
Oct 6, 2025
Merged

docs(tasks): enhance monorepo documentation with tool comparisons#6563
jdx merged 4 commits intomainfrom
docs/monorepo-tasks

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Oct 6, 2025

Introduces a dedicated Monorepo Tasks doc, adds it to the sidebar, and updates related configuration docs to reference it and clarify behavior.

  • Docs
  • New page: docs/tasks/monorepo.md — comprehensive guide for monorepo task paths, wildcards, inheritance, discovery, and best practices.
  • Task Configuration: Replaces the verbose monorepo section with a concise pointer to Monorepo Tasks.
  • Configuration: Refines monorepo root wording, adds note on tool/env inheritance, and updates link to Monorepo Tasks.
  • Site Navigation
    • Adds Monorepo Tasks to the Tasks sidebar in docs/.vitepress/config.ts.

Note

Adds a concise comparison of mise Monorepo Tasks to other tools with a feature matrix and guidance on when to choose mise vs alternatives.

  • Docs:
    • docs/tasks/monorepo.md:
      • Add “Comparison to Other Tools” covering simple runners (Taskfile, Just), JS-focused tools (Nx, Turborepo, Lerna), large build systems (Bazel, Buck2), and others (Rush, Moon).
      • Introduce a feature matrix comparing capabilities across categories and mise.
      • Add guidance on when to choose mise vs alternatives, highlighting language-agnostic support and non-hermetic simplicity.

Written by Cursor Bugbot for commit 0c4f501. This will update automatically on new commits. Configure here.

jdx and others added 2 commits October 6, 2025 13:41
- Create comprehensive monorepo tasks guide at docs/tasks/monorepo.md
- Document tool inheritance from parent configs
- Update task-configuration.md to reference new monorepo doc
- Update configuration.md to mention tool inheritance feature
- Consolidate all monorepo information in one place

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Add a new section comparing mise's Monorepo Tasks to other tools, highlighting advantages in multi-language support, simplicity, and unified task management.
- Discuss differences with simple task runners, JavaScript-focused tools, large-scale build systems, and other notable tools.
- Provide guidance on when to choose mise versus alternatives based on team needs and project scale.
Copilot AI review requested due to automatic review settings October 6, 2025 13:59
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR creates dedicated documentation for monorepo tasks by extracting detailed monorepo content from the general task configuration file into a specialized page. The changes improve documentation organization and provide comprehensive guidance on using mise's experimental monorepo features.

  • Extracts monorepo documentation from task-configuration.md into a dedicated monorepo.md file
  • Adds comprehensive tool comparison section comparing mise to other monorepo solutions
  • Updates navigation and cross-references to point to the new documentation

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
docs/tasks/task-configuration.md Removes detailed monorepo content and replaces with summary and link to dedicated page
docs/tasks/monorepo.md Creates new comprehensive monorepo documentation with examples, best practices, and tool comparisons
docs/configuration.md Updates cross-references to point to new monorepo documentation
docs/.vitepress/config.ts Adds navigation entry for the new monorepo tasks page

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread docs/tasks/monorepo.md Outdated
Comment on lines +61 to +62
Monorepo tasks use special path syntax with `//` and `:` prefixes. You can run these tasks directly with `mise` or with `mise run`. With non-monorepo tasks, the guidance is not to use the direct syntax for scripts because it could conflict
with future core mise commands, but mise will never define commands with a `//` or `:` prefix so that guidance does not apply to monorepo tasks.
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] This sentence is difficult to parse due to its length and complex structure. Consider breaking it into two sentences for better readability: 'You can run these tasks directly with mise or with mise run. While non-monorepo tasks should avoid direct syntax to prevent conflicts with future core mise commands, this guidance doesn't apply to monorepo tasks since mise will never define commands with // or : prefixes.'

Suggested change
Monorepo tasks use special path syntax with `//` and `:` prefixes. You can run these tasks directly with `mise` or with `mise run`. With non-monorepo tasks, the guidance is not to use the direct syntax for scripts because it could conflict
with future core mise commands, but mise will never define commands with a `//` or `:` prefix so that guidance does not apply to monorepo tasks.
Monorepo tasks use special path syntax with `//` and `:` prefixes. You can run these tasks directly with `mise` or with `mise run`. For non-monorepo tasks, the guidance is not to use the direct syntax for scripts because it could conflict with future core mise commands.
However, this guidance does not apply to monorepo tasks, since mise will never define commands with a `//` or `:` prefix.

Copilot uses AI. Check for mistakes.
Comment thread docs/tasks/monorepo.md
You can combine both types of wildcards for powerful patterns:

```bash
# Run all tasks in all projects (idk why you'd ever want to do this, but you can)
Copy link

Copilot AI Oct 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The informal comment 'idk why you'd ever want to do this' is unprofessional for technical documentation. Consider replacing with a more formal explanation like 'Run all tasks in all projects (use with caution in large repositories)' or simply remove the parenthetical comment.

Suggested change
# Run all tasks in all projects (idk why you'd ever want to do this, but you can)
# Run all tasks in all projects (use with caution in large repositories)

Copilot uses AI. Check for mistakes.
@jdx jdx changed the title docs/monorepo tasks docs(tasks): enhance monorepo documentation with tool comparisons Oct 6, 2025
@jdx jdx enabled auto-merge (squash) October 6, 2025 14:03
@jdx jdx merged commit ccec40a into main Oct 6, 2025
27 checks passed
@jdx jdx deleted the docs/monorepo-tasks branch October 6, 2025 14:14
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 6, 2025

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 x -- echo 17.9 ± 0.4 17.2 21.2 1.00
mise x -- echo 18.4 ± 0.6 17.4 21.1 1.03 ± 0.04

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 env 17.6 ± 0.6 16.7 23.0 1.00
mise env 17.8 ± 0.3 17.0 19.0 1.01 ± 0.04

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 hook-env 17.3 ± 0.5 16.6 24.9 1.00
mise hook-env 17.4 ± 0.3 16.6 18.8 1.00 ± 0.03

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 ls 15.3 ± 0.5 14.5 20.0 1.00
mise ls 16.1 ± 0.6 14.9 17.6 1.05 ± 0.05

xtasks/test/perf

Command mise-2025.10.3 mise Variance
install (cached) 201ms ✅ 109ms +84%
ls (cached) 65ms 65ms +0%
bin-paths (cached) 71ms 71ms +0%
task-ls (cached) 499ms 487ms +2%

✅ Performance improvement: install cached is 84%

jdx pushed a commit that referenced this pull request Oct 7, 2025
### 📦 Registry

- add jules by @alefteris in
[#6568](#6568)

### 🐛 Bug Fixes

- **(docs)** improve favicon support for Safari by @jdx in
[#6567](#6567)
- **(github)** download assets via API to respect GITHUB_TOKEN by @roele
in [#6496](#6496)
- **(task)** load toml tasks in `task_config.includes` in system/global
config and monorepo subdirs by @risu729 in
[#6545](#6545)
- **(task)** handle dots in monorepo directory names correctly by @jdx
in [#6571](#6571)

### 📚 Documentation

- **(readme)** add GitHub Issues & Discussions section by @rsyring in
[#6573](#6573)
- **(tasks)** create dedicated monorepo tasks documentation by @jdx in
[#6561](#6561)
- **(tasks)** enhance monorepo documentation with tool comparisons by
@jdx in [#6563](#6563)
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