Skip to content

Commit bc5efcb

Browse files
authored
Documentation: Update outdated references from "Crew" to "the Monorepo team" (#45512)
1 parent fa53b22 commit bc5efcb

File tree

30 files changed

+94
-24
lines changed

30 files changed

+94
-24
lines changed

docs/monorepo.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Starting a new project? Great! Let the Jetpack Generate Wizard help jumpstart th
6060

6161
* Make sure you're checked out to the branch you want.
6262
* 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.
6464

6565
### Accepted Arguments
6666

@@ -96,7 +96,7 @@ The Jetpack Generate Wizard includes the following for each project:
9696
- readme.txt
9797
- A main plugin.php (plugin_name.php), with filled in header
9898

99-
#### Github Actions
99+
#### GitHub Actions
100100

101101
- action.yml
102102

@@ -182,7 +182,7 @@ The test environment will be set up with appropriate tools, including node, pnpm
182182

183183
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.
184184

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).
186186

187187
The following environment variables are available for all tests:
188188

@@ -369,8 +369,8 @@ This assumes you have PHP installed via Homebrew, e.g. you've done `brew install
369369
370370
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.
371371
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`.
374374
2. The default branch should be `trunk`, matching the monorepo.
375375
* Note that you can't set the default branch until at least one branch is created in the repo.
376376
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
379379
6. Create any secrets needed (e.g. for Autotagger or Npmjs-Autopublisher). See PCYsg-xsv-p2#mirror-repo-secrets for details.
380380
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.
381381
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.
383383
3. If your project requires building, configure `.scripts.build-production` in your project's `composer.json` to run the necessary commands.
384384
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".
385385
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
485485
486486
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`.
487487
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.
489489
490490
## New Projects
491491
492492
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.
494494
* Use the `jetpack generate` command to create a skeleton project.
495495
* Create your project based on the skeleton and submit a PR as usual.
496496
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:
498498
* 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).
499499
500500
### Creating a new Composer Package

projects/packages/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ While the script we use to deploy the package takes care of everything, we might
7474
3. Add an initial valid `composer.json` to the repository. You can copy it from your PR in the Jetpack repo.
7575
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.
7676
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.
7878

7979

8080
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.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Significance: patch
2+
Type: changed
3+
Comment: Update references from Crew to the Monorepo team.
4+
5+

projects/packages/search/src/instant-search/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It enables the user to quickly jump into a full-page search experience with filt
1515
5. Test your changes on the front-end of your test site.
1616
6. Open a PR, and a WordPress.com diff will be automatically generated with your changes.
1717
7. Test the WordPress.com diff.
18-
8. Once the code works well in both environments and has been approved by a Jetpack crew member, you can merge your branch!
18+
8. Once the code works well in both environments, you can merge your branch!
1919

2020
### Build Setup
2121

projects/plugins/automattic-for-agencies-client/.w.org-assets/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This directory is intended to hold assets meant for w.org plugins SVN.
44

5-
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask Crew to deploy them.
5+
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask the Monorepo team to deploy them.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Significance: patch
2+
Type: changed
3+
Comment: Update references from Crew to the Monorepo team.
4+
5+

projects/plugins/backup/.w.org-assets/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This directory is intended to hold assets meant for w.org plugins SVN.
44

5-
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask Crew to deploy them.
5+
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask the Monorepo team to deploy them.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Significance: patch
2+
Type: changed
3+
Comment: Update references from Crew to the Monorepo team.
4+
5+

projects/plugins/boost/.w.org-assets/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This directory is intended to hold assets meant for w.org plugins SVN.
44

5-
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask Crew to deploy them.
5+
There is no auto-deployment of these assets, so once you make changes, please ping the plugin's team or ask the Monorepo team to deploy them.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Significance: patch
2+
Type: changed
3+
Comment: Update references from Crew to the Monorepo team.
4+
5+

0 commit comments

Comments
 (0)