Document manifest files #6197
Merged
Document manifest files #6197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pepicrft
requested review from
fortmarek and
kwridan
and removed request for
a team
danieleformichelli
approved these changes
Apr 16, 2024
Comment on lines
+29
to
+31
|
|
||
| > [!WARNING] ROOT VARIABLES | ||
| > The only variable that should be at the root of the manifest is `let project = Project(...)`. If you need to reuse code across various parts of the manifest, you can use Swift functions. |
There was a problem hiding this comment.
Why this? We have a lot of top-level variable and never had issues with it AFAIK
There was a problem hiding this comment.
I'm not sure. I'll have to investigate the next time we get a report.
docs/docs/guide/project/manifests.md
Outdated
Comment on lines
49
to
50
| > [!NOTE] | ||
| > Tuist will resolve the dependency graph and include the projects of the dependencies in the workspace. You don't need to include them manually. |
There was a problem hiding this comment.
I think we should explain what's the point of defining them here then
There was a problem hiding this comment.
Good idea. I added an additional sentence clarifying that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of the documentation revamp, I forgot to include a page explaining the different supported manifest files. This PR includes that page and also provides some guidelines for deciding between "mono or multi-project" setups, which is a recurrent question asked by users.