Documentation: Inconsistent instructions on whether to commit routeTree.gen.ts

[paradoxloop]

Which project does this relate to?

Router

Describe the bug

The instructions on whether to commit routeTree.gen.ts to git are inconsistent between router and start. The project should have a consistent view of whether the generated route file should be committed.

Router says:

Yes! ..... You should commit this file into git so that other developers can use it to build your application.

Start says

You may gitignore this file, since it is a build artifact.

Your Example Website or App

NA

Steps to Reproduce the Bug or Issue

NA

Expected behavior

NA

Screenshots or Videos

NA

Platform

NA

Additional context

No response

[nyomansunima]

I think, we don't need to commit this file, because every deployment will generate a new build artifacts. Also this works across all of the hosting providers even on the CI.

Suggestion: Add it to .gitignore, then add a new warning to build this before deploy.
@schiller-manuel how's that?

[Christopher96u]

I think, we don't need to commit this file, because every deployment will generate a new build artifacts. Also this works across all of the hosting providers even on the CI.

Suggestion: Add it to .gitignore, then add a new warning to build this before deploy. @schiller-manuel how's that?
My 2 cents is that we need it. I had issues before on our pipeline when I removed the generated file idk why but had that issue few times, found out I had to commit it (it uses to happen around 6 months ago)

[johnf]

One disadvantage of not committing it is that you need to generate it in CI before doing any type checking or static analysis.

[Christopher96u]

One disadvantage of not committing it is that you need to generate it in CI before doing any type checking or static analysis.

That's what happened in our CI. So we had to commit it

[nyomansunima]

Hmm, that's make sense.

[Yavnik]

Apart from whether to commit it or not, there is difference in definition of the file itself.

Router docs says:

...it is essentially part of your application’s runtime, not a build artifact.

Start docs says

You may gitignore this file, since it is a build artifact

This is creating confusion. One thing we can do is remove the line from start's doc and let router's doc be the single source of truth.

[schiller-manuel]

@Yavnik create a pr for the docs and we can merge this

[schiller-manuel]

@Yavnik create a pr for the docs and we can merge this