Merge pull request #121 from packagist/explain-reasons-for-create-project

pscheit · web-flow · commit 6d477f50d15c · 2025-02-18T19:33:56.000+01:00
Explain suggested `create-project` approach
diff --git a/docs/setup.md b/docs/setup.md
@@ -27,6 +27,9 @@ Once the command is finished, the created composer.json file will contain your o
 ]
 ```
 
+Alternatively, it is possible to configure your template package to already include your Private Packagist repository in its composer.json. We do not encourage this approach, because this pre-defined repository
+will cause conflicts if you rely on functionality that uses different private repositories, such as suborganizations or vendor customers. If you do prefer to take this approach, you should remove the `--add-repository` option from the `create-project` command.  
+
 Note: Running `composer create-project` with multiple `--repository` arguments is only supported with Composer 2.
 
 ## Adding Private Packagist to an existing project with a composer.json

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,9 @@ Once the command is finished, the created composer.json file will contain your o`
`27`	`27`	`]`
`28`	`28`	```
`29`	`29`
	`30`	`+Alternatively, it is possible to configure your template package to already include your Private Packagist repository in its composer.json. We do not encourage this approach, because this pre-defined repository`
	`31`	+will cause conflicts if you rely on functionality that uses different private repositories, such as suborganizations or vendor customers. If you do prefer to take this approach, you should remove the `--add-repository` option from the `create-project` command.
	`32`	`+`
`30`	`33`	Note: Running `composer create-project` with multiple `--repository` arguments is only supported with Composer 2.
`31`	`34`
`32`	`35`	`## Adding Private Packagist to an existing project with a composer.json`