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
Copy file name to clipboardExpand all lines: docs/monorepo.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ Starting a new project? Great! Let the Jetpack Generate Wizard help jumpstart th
60
60
61
61
* Make sure you're checked out to the branch you want.
62
62
* Use the CLI command `jetpack generate` to start the process.
63
-
* The wizard will walk you through the steps of starting a new package, plugin, or Github action.
63
+
* The wizard will walk you through the steps of starting a new package, plugin, or GitHub action.
64
64
65
65
### Accepted Arguments
66
66
@@ -96,7 +96,7 @@ The Jetpack Generate Wizard includes the following for each project:
96
96
- readme.txt
97
97
- A main plugin.php (plugin_name.php), with filled in header
98
98
99
-
#### Github Actions
99
+
#### GitHub Actions
100
100
101
101
- action.yml
102
102
@@ -182,7 +182,7 @@ The test environment will be set up with appropriate tools, including node, pnpm
182
182
183
183
All test commands must return a shell failure status when tests fail and a success status if tests pass or are skipped; usually your testing framework will already do this for you, but if you write custom shell scripts you'll need to make sure any failure is propagated.
184
184
185
-
If your project has multiple logical groups of tests, feel free to make use of GitHub Actions's [grouping commands](https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#grouping-log-lines).
185
+
If your project has multiple logical groups of tests, feel free to make use of GitHub Actions [grouping commands](https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#grouping-log-lines).
186
186
187
187
The following environment variables are available for all tests:
188
188
@@ -369,8 +369,8 @@ This assumes you have PHP installed via Homebrew, e.g. you've done `brew install
369
369
370
370
Most projects in the monorepo should have a mirror repository holding a built version of the project, ready for deployment. Follow these steps to create the mirror repo and configure the monorepo tooling to push to it.
371
371
372
-
1. Create the mirror repo on GitHub. It will most likely be named like "<span>https://</span>github.com/Automattic/jetpack-_something_".
373
-
1. The repo's description should begin with `[READ ONLY]` and end with `This repository is a mirror, for issue tracking and development head to: https://github.com/automattic/jetpack`.
372
+
1. Create the mirror repo on GitHub. It will most likely be named like "https://github.com/Automattic/jetpack-_something_".
373
+
1. The repo's description should begin with `[READ ONLY]` and end with `This repository is a mirror; for issue tracking and development head here: https://github.com/automattic/jetpack`.
374
374
2. The default branch should be `trunk`, matching the monorepo.
375
375
* Note that you can't set the default branch until at least one branch is created in the repo.
376
376
3. In the repo's settings, turn off wikis, issues, projects, and so on.
@@ -379,7 +379,7 @@ Most projects in the monorepo should have a mirror repository holding a built ve
379
379
6. Create any secrets needed (e.g. for Autotagger or Npmjs-Autopublisher). See PCYsg-xsv-p2#mirror-repo-secrets for details.
380
380
2. For a PHP package (or a plugin listed in Packagist) you also need to go to packagist.org and create the package there. This requires pushing a first commit with a valid `composer.json` to the repository. That can be done by copying the new package's `composer.json` from the PR that introduced it.
381
381
1. Be sure that `automattic` is added as a maintainer.
382
-
2. If creating the package with your own account, make sure to link your Github account to Packagist so that you can sync the new package.
382
+
2. If creating the package with your own account, make sure to link your GitHub account to Packagist so that you can sync the new package.
383
383
3. If your project requires building, configure `.scripts.build-production` in your project's `composer.json` to run the necessary commands.
384
384
4. If there are any files included in the monorepo that should not be included in the mirror, use `.gitattributes` to tag them with "production-exclude".
385
385
5. If there are any built files in `.gitignore` that should be included in the mirror, use `.gitattributes` to tag them with "production-include".
@@ -485,16 +485,16 @@ Comment: Update composer.lock, no need for a changelog entry
485
485
486
486
The “Linting / Changelogger validity” GitHub Actions check will help in making sure that all these version numbers are in sync with the version inferred from the changelog and change files. You can also check this locally with `tools/changelogger-validate-all.sh`.
487
487
488
-
Within a single project, changlogger’s `version next` command can tell you the next version, and the monorepo script `tools/project-version.sh` can be used to check and update the version numbers.
488
+
Within a single project, changelogger’s `version next` command can tell you the next version, and the monorepo script `tools/project-version.sh` can be used to check and update the version numbers.
489
489
490
490
## New Projects
491
491
492
492
To begin,
493
-
* For Automatticians, drop us a line in #jetpack-crew to discuss your needs, just to be sure we don't have something already. For others, it would probably be best to open an issue to discuss it.
493
+
* For Automatticians, drop us a line in #jetpack-monorepo to discuss your needs, just to be sure we don't have something already. For others, it would probably be best to open an issue to discuss it.
494
494
* Use the `jetpack generate` command to create a skeleton project.
495
495
* Create your project based on the skeleton and submit a PR as usual.
496
496
497
-
Once we're sure that the project will be created and what its name will be, someone (you or the Crew team) does the following:
497
+
Once we're sure that the project will be created and what its name will be, someone (you or the Monorepo team) does the following:
498
498
* Create a GitHub repo in the Automattic repo to be the mirror repo for this project. The new repo follows the [mirror repo guidelines](#mirror-repositories).
Copy file name to clipboardExpand all lines: projects/packages/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ While the script we use to deploy the package takes care of everything, we might
74
74
3. Add an initial valid `composer.json` to the repository. You can copy it from your PR in the Jetpack repo.
75
75
4. You'll want to update the repository settings to be just like the Autoloader repo; check the repository description, disable issues, set up branch protection rules for the `trunk` branch.
76
76
5. Go to https://packagist.org/packages/submit and insert the URL of the GitHub repository.
77
-
6. Upon submission, add Crew members as package maintainers, as well as the `automattic` account.
77
+
6. Upon submission, add Monorepo members as package maintainers, as well as the `automattic` account.
78
78
79
79
80
80
Once this is all done, you can merge your PR in the Jetpack repo. When you do so, the changes will be automatically pushed to the new package repo, and your changes will become available in the `dev-trunk` version of the package available to the public.
0 commit comments