You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README with accurate information (#89)
- Fix broken links and outdated blog references
- Update PHP version requirements (8.2+ for v12, 8.1 for v11)
- Correct import namespaces and phpstan version
- Add complete list of merged composer.json sections
- Include all available commands documentation
Do you maintain [a monorepo](https://tomasvotruba.com/blog/2019/10/28/all-you-always-wanted-to-know-about-monorepo-but-were-afraid-to-ask/) with more packages?
5
+
Do you maintain a monorepo with multiple packages?
6
6
7
7
**This package has few useful tools, that will make that easier**.
8
8
9
9
## Install
10
10
11
11
```bash
12
+
# Latest version (PHP 8.2+)
12
13
composer require symplify/monorepo-builder --dev
14
+
15
+
# For PHP 8.1 (legacy version, no longer maintained)
The best to lean-in fast is to read basic intro at blog post [All You Always Wanted to Know About Monorepo](https://www.tomasvotruba.com/blog/2019/10/28/all-you-always-wanted-to-know-about-monorepo-but-were-afraid-to-ask/#what-is-monorepo).
20
-
We also made a simple command to make that easy for you:
29
+
If you're new to monorepos, you can start with a basic setup using our initialization command:
21
30
22
31
```bash
23
32
vendor/bin/monorepo-builder init
24
33
```
25
34
26
-
And the basic setup is done!
35
+
This creates a basic monorepo structure with the necessary configuration files.
36
+
27
37
28
38
### 2. Merge local `composer.json` to the Root One
29
39
30
40
Merges configured sections to the root `composer.json`, so you can only edit `composer.json` of particular packages and let script to synchronize it.
31
41
32
-
Sections that are needed for monorepo to work will be merged:
42
+
Sections that will be merged from packages to root:
33
43
34
-
- 'require'
35
-
- 'require-dev'
36
-
- 'autoload'
37
-
- 'autoload-dev'
38
-
- 'repositories'
39
-
- 'extra'
44
+
-`require` - Dependencies needed by packages
45
+
-`require-dev` - Development dependencies
46
+
-`autoload` - PSR-4 autoloading configuration
47
+
-`autoload-dev` - Development autoloading configuration
Thanks to GitHub Actions, this was never simpler to set up. Use [symplify/github-action-monorepo-split](https://github.com/symplify/github-action-monorepo-split).
160
+
You can split packages from your monorepo into separate repositories using GitHub Actions. Use [symplify/github-action-monorepo-split](https://github.com/symplify/github-action-monorepo-split) for this purpose.
147
161
148
-
How to configure it? See our local setup at [.github/workflows/split_monorepo.yaml](https://github.com/danharrin/monorepo-split-github-action/blob/main/.github/workflows/split.yaml)
162
+
For configuration examples, you can refer to the [GitHub Action workflow documentation](https://github.com/danharrin/monorepo-split-github-action).
0 commit comments