这是indexloc提供的服务,不要输入任何密码
Skip to content

Conversation

@charpeni
Copy link
Contributor

Description

Add mentions to turborepo-summary and turborepo-summary-action as useful tools to turn Turborepo's run summary into a human-readable format.

Before After
CleanShot 2025-10-27 at 15 50 01@2x CleanShot 2025-10-27 at 16 00 18@2x
CleanShot 2025-10-27 at 16 03 07@2x CleanShot 2025-10-27 at 16 03 30@2x

Testing Instructions

@charpeni charpeni requested review from a team and anthonyshew as code owners October 27, 2025 20:22
@charpeni charpeni requested a review from tknickman October 27, 2025 20:22
@turbo-orchestrator turbo-orchestrator bot added the area: docs Improvements or additions to documentation label Oct 27, 2025
@vercel
Copy link
Contributor

vercel bot commented Oct 27, 2025

@charpeni is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@anthonyshew
Copy link
Contributor

Wow, this is awesome! Before going on about anything else, would you want to put turborepo-summary, the UI, into turborepo.com itself? I'm thinking it could just be the UI on some route like turborepo.com/tools/summary-viewer. Then people could use it as an official tool!

@charpeni
Copy link
Contributor Author

Hey @anthonyshew, I authored turborepo-summary, a CLI tool that reads a run JSON file and converts it to Markdown. turborepo-summary-action is wrapping this CLI to append the markdown report to the GitHub Action Job Summary. turborepo-summary could also generate an HTML file if we wanted to at some point.

The UI you are referring to—which was already part of the documentation—is probably https://turbo.nullvoxpopuli.com (which is authored by @NullVoxPopuli).

I would be happy to turn turborepo-summary into a UI that lets you drag and drop to generate a markdown report, but I felt https://turbo.nullvoxpopuli.com would be more appropriate for that. I focused on the markdown format so we can easily share those summaries without having to host an HTML file (e.g., GitHub Actions).


Something even better would be the ability to "pre-link" a run summary to a web viewer:

  1. Summarize the run summary (😅) and turn it into a smaller payload
    1.1. To avoid hitting URL limits, as passing the whole JSON file in the URL seems like it would be hard to scale
  2. Then link to turborepo.com/tools/summary-viewer?payload=[CLI-OUTPUT]

If payload isn't provided, we can still drag and drop a run JSON file to visualize it within the web viewer and turn it into a shareable summary! (turborepo.com/tools/summary-viewer?payload=[CLI-OUTPUT])

Happy to collaborate with both of you on the proper implementation for the community!

Copy link
Contributor

@anthonyshew anthonyshew left a comment

Choose a reason for hiding this comment

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

No worries! Let's add this link for now while a Turborepo-native UI gets built.

@anthonyshew anthonyshew changed the title docs: add mentions to turborepo-summary and turborepo-summary-action docs: Add mentions to turborepo-summary and turborepo-summary-action Nov 12, 2025
@vercel
Copy link
Contributor

vercel bot commented Nov 12, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
examples-basic-web Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-designsystem-docs Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-gatsby-web Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-kitchensink-blog Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-nonmonorepo Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-svelte-web Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-tailwind-web Ready Ready Preview Comment Nov 12, 2025 10:33pm
examples-vite-web Ready Ready Preview Comment Nov 12, 2025 10:33pm
turbo-site Ready Ready Preview Comment Nov 12, 2025 10:33pm

@anthonyshew anthonyshew merged commit 592f124 into vercel:main Nov 12, 2025
36 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants