Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Task outputs clarifications #9185

Merged
merged 2 commits into from
Sep 28, 2024

Conversation

boutchitos
Copy link
Contributor

To avoid the impression that cache is disabled when Task outputs key is ommitted.

API reference was more accurate for that behavior, than Crafting your repository.

Description

I'm new to Turborepo, and was reading Crafting your repository. Two sections lead me to conclude that when there is no outputs key in a Task, then caching is disabled. I think the wording in API reference is better.

We have to account for Logs output even if there are no file outputs (which is really nice for linters).

Testing Instructions

  • Review the modified documentations.
  • Take into account that I'm not a native english speaker (you probably notice already ;) )

To avoid the impression that cache is disabled when
`outputs` key is ommitted.

`API reference` was more accurate for that behavior,
than `Crafting your repository`.
@boutchitos boutchitos requested review from anthonyshew and a team as code owners September 26, 2024 01:28
@turbo-orchestrator turbo-orchestrator bot added area: docs Improvements or additions to documentation needs: triage New issues get this label. Remove it after triage owned-by: turborepo labels Sep 26, 2024
Copy link

vercel bot commented Sep 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
examples-basic-web ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview Sep 26, 2024 1:36pm

Copy link

vercel bot commented Sep 26, 2024

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

A member of the Team first needs to authorize it.

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.

Thanks for these updates! I see how this could be clearer now that you're pointing it out and think we can keep improving on your initial draft. Check out the comments and suggestions I've provided and let me know what you think.

@boutchitos
Copy link
Contributor Author

@anthonyshew: I applied your suggestions!

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.

Looks great! Thank you for contributing back!

@anthonyshew anthonyshew merged commit cc473cb into vercel:main Sep 28, 2024
10 of 13 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 needs: triage New issues get this label. Remove it after triage owned-by: turborepo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants