Skip to content

Commit

Permalink
[SITE-988] Consolidate WordPress Composer Build Tools docs with the r…
Browse files Browse the repository at this point in the history 
…egular Build Tools docs (#9236)

* Move most of the build-tools content for WP into the Build Tools create project doc

* [SITE-988] Consolidate WordPress Composer multisite config doc with the existing Multisite Configuration doc (#9260)

* delete the multisite config guide under wordpress-composer

* add relevant info from the wpcm multisite config to the main multisite config guide

* [SITE-988] Consolidate WPCM Custom Upstream documentation with the existing IC custom upstream documentation (#9261)

* update ic-upstream-structure partial to match wpcm

* add contributor and bump reviewed date

* update wpcm link

* add additional (cms-agnostic) info from wpcm ic doc

* add additional resources (from wpcm cu doc)

* delete the wpcm ic doc
  • Loading branch information
@jazzsequence
jazzsequence authored Oct 15, 2024
1 parent 31042e9 commit b130235
Show file tree
Hide file tree
Showing 7 changed files with 242 additions and 433 deletions.
197 changes: 166 additions & 31 deletions source/content/guides/build-tools/02-create-project.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Build Tools
subtitle: Create a New Project
description: In step two of the Build Tools guide, learn how to create a new Build Tools project.
tags: [composer, terminus, webops, workflow, D8, D9, D10]
tags: [composer, terminus, webops, workflow, D8, D9, wordpress]
type: guide
permalink: docs/guides/build-tools/create-project/
editpath: build-tools/02-create-project.md
reviewed: "2021-12-13"
reviewed: "2024-09-26"
contenttype: [guide]
innav: [false]
categories: [dependencies]
Expand All @@ -16,7 +16,7 @@ product: [--]
integration: [--]
---

In this section, we will use the Terminus Build Tools Plugin to create a new project consisting of a Git repository, a Continuous Integration service, and a Pantheon site.
In this section, we will use the Terminus Build Tools Plugin to create a new project consisting of a Git repository, [Composer](https://getcomposer.org), a Continuous Integration (CI) service, and a Pantheon site with Automated Testing. This guide will get you started, but you will need to customize and maintain the CI/testing set up for your projects.

<Alert title="Note" type="info">

Expand All @@ -26,35 +26,14 @@ Substitute your chosen Git Provider and CI service in these instructions with th

</Alert>

## Prerequisites
## Requirements

Ensure you have the latest versions of Terminus and the Terminus Build Tools plugin installed. You may want to run `terminus self:plugin:update pantheon-systems/terminus-build-tools-plugin` to ensure you have the most recent version.

1. Install [Composer](/guides/composer).
- Verify your installation with `composer --version`:

```bash{outputLines: 2}
composer --version
Composer version 2.1.8 2021-09-15 13:55:14
```

1. Install the most recent release of [Terminus](/terminus/).
- Verify your installation with `terminus --version`:

```bash{outputLines: 2}
terminus --version
Terminus 3.0.1
```

1. [Add an SSH key](/ssh-keys) in your Personal Workspace.

1. [Generate a Pantheon machine token](https://dashboard.pantheon.io/machine-token/create), then authenticate Terminus.

1. Install the [Terminus Build Tools Plugin](https://github.com/pantheon-systems/terminus-build-tools-plugin):

```bash{promptUser: user}
terminus self:plugin:install terminus-build-tools-plugin
```
* [Composer](/guides/integrated-composer)
* [Terminus](/terminus/)
* [Terminus Build Tools Plugin](https://github.com/pantheon-systems/terminus-build-tools-plugin)
* [PHP version](https://docs.pantheon.io/guides/php/php-versions#verify-current-php-versions) 7.2 or greater
* [An SSH key](/ssh-keys) in your Personal Workspace.
* [A Pantheon machine token](https://dashboard.pantheon.io/machine-token/create), to authenticate Terminus.

### Access Tokens (Optional)

Expand Down Expand Up @@ -119,16 +98,172 @@ Modify the commands in the following examples to match your project's needs.
terminus build:project:create --git=github --team='My Agency Name' wp my-site
```

<Alert title="Note" type="info">

Pantheon has a [WordPress (Composer Managed)](/guides/wordpress-composer/wordpress-composer-managed) upstream. You can use this upstream to create a Composer-managed WordPress site with **Bedrock**. **Terminus Build Tools** does not currently support the Bedrock-based WordPress (Composer Managed) upstream.

</Alert>

- Start a GitHub project with Drupal:

```bash{promptUser: user}
terminus build:project:create --git=github --team='My Agency Name' d9 my-site
```

<Alert title="Note" type="info">

Support has not yet been added for Drupal versions past 9, however you can still update to the latest Drupal version after creating the project.

</Alert>

The script will ask for additional information such as tokens/credentials for GitHub and the associated CI.

For a list of all available command options, see the [Build Tools Project README](https://github.com/pantheon-systems/terminus-build-tools-plugin/blob/3.x/README.md#buildprojectcreate)

## Review Important Directories and Update File Paths

### `/web` Directory

Your site is stored and served from the `/web` subdirectory located next to the `pantheon.yml` file. You must store your website in this subdirectory for a Composer-based workflow. Placing your website in the subdirectory also allows you to store tests, scripts, and other files related to your project in your repo without affecting your web document root. It also provides additional security by preventing web access to files outside of the document root through Pantheon.
Your files may still be accessible from your version control project if it is public. See the [`pantheon.yml` documentation](/pantheon-yml#nested-docroot) for details.

1. Verify that your website is stored in the `/web` subdirectory.

### `composer.json` File

This project uses Composer to manage third-party PHP dependencies. Some files, such as core CMS packages inside the `/web` directory, may not be visible in the repository. This is because the CMS (Drupal or WordPress) and its plugins/modules are installed via Composer and ignored in the `.gitignore` file.

Third-party dependencies, such as modules, plugins and themes, are added to the project via `composer.json` file. The `composer.lock` file keeps track of the exact dependency version. For WordPress, Composer installer-paths are used to ensure the dependencies are downloaded into the appropriate directory.

1. Place all dependencies in the **require** section of your `composer.json` file.

- This includes dependencies that are only used in non-Live environments. All dependencies in the **require** section are pushed to Pantheon.

1. Place all dependencies that are not a part of the web application but are necessary to build or test the project in the **require-dev** section.

- Example dependencies are `php_codesniffer` and `phpunit`. Dev dependencies are deployed to Dev and Multidev environments, but not to Test and Live environments.

## Continuous Integration

The scripts that run on Continuous Integration are stored in the `.ci` directory. Provider-specific configuration files, such as `.circle/config.yml` and `.gitlab-ci.yml` use these scripts.

The scripts are organized into subdirectories according to their function:

- Build
- Deploy
- Test

### Build Scripts .ci/build

- `.ci/build` script builds an artifact suitable for deployment.

- `.ci/build/php` installs PHP dependencies with Composer.

### Build Scripts `.ci/deploy`

All scripts stored in the `.ci/deploy` directory facilitate code deployment to Pantheon.

- `.ci/deploy/pantheon/create-multidev` creates a new [Pantheon Multidev environment](/guides/multidev) for branches other than the default Git branch. Note that not all users have Multidev access. Please consult the [Multidev FAQ doc](/guides/multidev/multidev-faq) for details.

- `.ci/deploy/pantheon/dev-multidev` deploys the built artifact to either the Pantheon Dev or a Multidev environment, depending on the Git branch.

## Automated Test Scripts `.ci/tests`

The `.ci/tests` scripts run automated tests. You can add or remove scripts depending on your testing needs.

### Static Testing

- `.ci/test/static` and `tests/unit` are static tests that analyze code without executing it. These tests are good at detecting syntax errors but not functionality errors.

- `.ci/test/static/run` runs [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with [WordPress coding standards](https://github.com/WordPress/WordPress-Coding-Standards) (for WordPress sites), [PHP Unit](https://phpunit.de/), and [PHP syntax checking](https://phpcodechecker.com/).

- `tests/unit/bootstrap.php` bootstraps the Composer autoloader.

- `tests/unit/TestAssert.php` provides an example Unit test.

1. Create all project-specific test files in the `tests/unit` directory.

### Visual Regression Testing

The scripts stored in the `.ci/test/visual-regression` directory run visual regression testing through a headless browser to take screenshots of web pages and compare them for visual differences.

- `.ci/test/visual-regression/run` runs [BackstopJS](https://github.com/garris/BackstopJS) visual regression testing.

- `.ci/test/visual-regression/backstopConfig.js` is the [BackstopJS](https://github.com/garris/BackstopJS) configuration file.

1. Update the settings in `.ci/test/visual-regression/backstopConfig.js` file for your project.

- For example, the `pathsToTest` variable determines the URLs to test.

## GitHub Actions

This section provides information enabling GitHub Actions for your site.

The Build Tools Site will configure GitHub Actions automatically if it was passed as the selected CI when creating the site. You will need to consult advanced external resources if you're working with an existing non-Build Tools site and want to add Github Actions.

The steps to enable GitHub Actions for an existing Build Tools site created with another CI (for example, CircleCI) shown below might work for you.

1. Copy `.ci/.github` to `.github`.

1. Add the following secrets to the Github Actions configuration:

- `ADMIN_EMAIL`

- `ADMIN_PASSWORD`

- `ADMIN_USERNAME`

- `TERMINUS_TOKEN`

- `TERMINUS_SITE`

- `SSH_PRIVATE_KEY`

- `GH_TOKEN`


## Working Locally with Lando

Complete the one-time steps below to get started using [Lando](https://docs.devwithlando.io/) for local development. Please note than Lando is an independent product and is not supported by Pantheon. Refer to the [Lando documentation](https://docs.devwithlando.io/) for more information.

1. [Install Lando](https://docs.lando.dev/getting-started/installation.html) if it is not already installed.

1. Clone your project repository from GitHub to your local.

1. Manually create a `.lando.yml` file with your preferred configuration, based on the WordPress recipe.

1. Run `lando start` to start Lando.

1. Save the local site URL.

- The local site URL should look similar to: `https://<PROJECT_NAME>.lndo.site.`

1. Run the command below to download dependencies.

```bash
`lando composer install --no-ansi --no-interaction --optimize-autoloader --no-progress`
```

1. Run the command below to download the media files and database from Pantheon.

```bash
`lando pull --code=none`
```

1. Visit the local site URL saved in the preceding steps.

- You should now be able to edit your site locally. The steps above do not need to be completed on subsequent starts. You can stop Lando with `lando stop` and start it again with `lando start`.

1. Run all Composer, Terminus and wp-cli commands in Lando instead of the host machine.

- This is done by prefixing the desired command with `lando`. For example, after a change to `composer.json` run `lando composer update` rather than `composer update`.

<Alert title="Warning" type="danger" >

Do NOT push/pull code between Lando and Pantheon directly. All code should be pushed to GitHub and deployed to Pantheon through a continuous integration service, such as CircleCI.

</Alert>

### Troubleshooting

<Accordion title="Troubleshooting" id="troubleshoot-install" icon="wrench">
Expand Down
37 changes: 31 additions & 6 deletions source/content/guides/integrated-composer/06-ic-upstreams.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Integrated Composer
subtitle: Custom Upstream Usage
description: Learn how to use an Upstream with Integrated Composer.
tags: [composer, workflow]
contributors: [ari, edwardangert]
reviewed: "2022-12-13"
contributors: [ari, edwardangert, jazzsequence]
reviewed: "2024-10-15"
showtoc: true
permalink: docs/guides/integrated-composer/ic-upstreams
contenttype: [guide]
Expand All @@ -21,20 +21,45 @@ This section provides usage and maintanenance information for composer-managed [

## Custom Upstreams

An Upstream refers to the source code in Git that shares a Git history with "downstream" individual sites made from it. Upstreams includes the core code for [Drupal](https://github.com/pantheon-upstreams/drupal-composer-managed), [WordPress](https://github.com/pantheon-upstreams/wordpress-project), and some customizations for the Pantheon platform.
An Upstream refers to the source code in Git that shares a Git history with "downstream" individual sites made from it. Upstreams includes the core code for [Drupal](https://github.com/pantheon-upstreams/drupal-composer-managed), [WordPress](https://github.com/pantheon-upstreams/wordpress-composer-managed), and some customizations for the Pantheon platform.

### Custom Upstream and Site Structure

<Partial file="ic-upstream-structure.md" />

<Partial file="upstream-management-dependencies.md" />

## Create Your Integrated Composer Custom Upstream

Follow the steps in this section to create a custom upstream that uses Integrated Composer.

1. Fork the Pantheon-maintained [WordPress (Composer Managed)](https://github.com/pantheon-upstreams/wordpress-composer-managed) or [Drupal Composer Managed](https://github.com/pantheon-upstreams/drupal-composer-managed) upstream repository.

1. [Connect your repository](/guides/custom-upstream/create-custom-upstream#connect-repository-to-pantheon) to Pantheon.

1. Update the **require** section of the root `/composer.json` file to match the name you chose in the preceding step.

## Add and Remove Packages

1. Use `composer require`in the `upstream-configuration` directory (or `composer upstream-require` if using `upstream-management`) to edit the upstream `composer.json` file.
- The WordPress (Composer Managed) repository places a theme in the upstream `composer.json` file. This works well for downstream sites that all use the same theme. You should remove themes from the upstream `composer.json` file if you do not intend to use the upstream to lock downstream sites into a particular theme. You cannot remove installed packages from downstream sites if the packages were included from the upstream site.

## Maintain Your Integrated Composer Fork

There are some special considerations to keep in mind if you intend to make modifications to your upstream based on this repository.

1. Increase the version number listed in the `upstream-configuration/composer.json` file each time you make edits.
- Composer checks the contents of the root `/composer.json` file for changes that should be pushed to your upstream configuration.

1. Verify your changes to the `upstream-configuration/composer.json` file by running `composer install` or `composer update` in the `upstream-configuration` directory.
- Be careful not to rely on ["root-only" properties of composer.json](https://getcomposer.org/doc/04-schema.md).

## More Resources

- [Custom Upstreams](/guides/custom-upstream)

- [Autopilot for Custom Upstreams](/guides/autopilot-custom-upstream)

- [Migrate a Custom Upstream to Drupal](/guides/drupal-hosted-createcustom)

- [Pantheon YAML Configuration Files](/pantheon-yml)
- [Best Practices for Maintaining Custom Upstreams](/guides/custom-upstream/maintain-custom-upstream)
- [Composer Fundamentals and WebOps Workflows](/guides/composer)
- [Create a Composer-managed WordPress Site with Bedrock](/guides/wordpress-composer/wordpress-composer-managed)
46 changes: 41 additions & 5 deletions source/content/guides/multisite/03-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,42 @@ Complete the steps below after spinning up a new WPMS site from the correct Cust
/* That's all, stop editing! Happy Pressing. */
```

## Setting up Multisite on WordPress (Composer Managed) sites

The [Bedrock](https://roots.io/bedrock/)-based [WordPress (Composer Managed)](https://github.com/pantheon-systems/wordpress-composer-managed) upstream uses `Config::define()` and `config/application.php` instead of traditional `define()` statements in `wp-config.php`. You will not be able to use WP-CLI via Terminus to enable multisite as documented above in a standard multisite configuration. This section provides guidance on how to set up a WordPress Multisite using the WordPress (Composer Managed) upstream.

1. Set the site's connection mode to Git:

```bash{promptUser: user}
terminus connection:set <site>.dev git
```
2. Open the `config/application.php` file in your site's codebase and add the following line anywhere _above_ the `Config::apply();` line:

```php
Config::define( 'WP_ALLOW_MULTISITE', true );
```
3. Visit your development site's WordPress admin and navigate to **Tools** > **Network Setup**.
![Network Setup page](../../../images/wordpress-composer/04-multisite-network-setup.png)
4. Choose **Sub-domains** or **Sub-directories** (depending on your needs), fill in the Network Title and Admin Email, and click **Install**.
5. You will be given instructions to update your `config/application.php` file. Below where you added the `WP_ALLOW_MULTISITE` line, copy and paste the code provided. The `SUBDOMAIN_INSTALL` value will be `true` or `false` depending on the option you chose in the previous step. For example, if you chose subdirectories, your `config/application.php` file should look like this:

```php
Config::define( 'MULTISITE', true );
Config::define( 'SUBDOMAIN_INSTALL', false );
// Use PANTHEON_HOSTNAME if in a Pantheon environment, otherwise use HTTP_HOST.
Config::define( 'DOMAIN_CURRENT_SITE', defined( 'PANTHEON_HOSTNAME' ) ? PANTHEON_HOSTNAME : $_SERVER['HTTP_HOST'] );
Config::define( 'PATH_CURRENT_SITE', '/' );
Config::define( 'SITE_ID_CURRENT_SITE', 1 );
Config::define( 'BLOG_ID_CURRENT_SITE', 1 );
```
6. Save your changes and commit them to your Git repository. WordPress will prompt you to log back in after you push the changes.
7. Log into your site. When you log back into your WordPress admin dashboard, you will see a new **My Sites** menu item in the top left corner. This is where you can manage your network of sites. You now have a WordPress subdirectory multisite network set up on a WordPress (Composer Managed)-based upstream.
![My Sites](../../../images/wordpress-composer/04-multisite-my-sites.png)

<Alert type="danger" title="Multisite Search and Replace with WordPress (Composer Managed)">
Currently, the built-in dashboard [WordPress Multisite Search and Replace](/guides/multisite/search-replace/) does not support Composer-based WordPress multisites. To perform a search and replace on a WordPress (Composer Managed) multisite, you will need to use WP-CLI via Terminus manually. For more information, see our [WordPress Multisite Search and Replace](guides/multisite/workflows/#run-wp-cli-search-replace-manually) guide.
</Alert>

## Develop the Multisite

Congratulations on setting up your first WordPress Multisite. When you log in to the WordPress Dashboard, you'll see a **My Sites** menu item in the toolbar:
Expand Down Expand Up @@ -178,8 +214,8 @@ define( 'DOMAIN_CURRENT_SITE', PANTHEON_HOSTNAME );
## More Resources
- [Environment-Specific Configuration for WordPress Sites](/guides/environment-configuration/environment-specific-config)
- [WordPress Pantheon Cache Plugin Configuration](/guides/wordpress-configurations/wordpress-cache-plugin)
- [WordPress with Composer on Pantheon](/guides/wordpress-composer)
* [Environment-Specific Configuration for WordPress Sites](/guides/environment-configuration/environment-specific-config)
* [WordPress Pantheon Cache Plugin Configuration](/guides/wordpress-configurations/wordpress-cache-plugin)
* [WordPress with Composer on Pantheon](/guides/wordpress-composer)
* [WordPress Multisite documentation](https://developer.wordpress.org/advanced-administration/multisite/)
* [WordPress Multisite Domain Mapping](https://developer.wordpress.org/advanced-administration/multisite/domain-mapping/)
Loading

0 comments on commit b130235

Please sign in to comment.