Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 2.92 KB

development-environment.md

File metadata and controls

101 lines (64 loc) · 2.92 KB
Raw

Setting up your environment

Overview

In order to start developing the ActivityPub plugin you want to have access to a WordPress installation where you can install the plugin and work on it.

To do that you need to set up a WordPress site and give it the ability to run your local build of the ActivityPub plugin code repository.

There are several ways to achieve this, listed in the next section.

Get started with development

Clone the repository

Before you get started, we recommend that you set up a public SSH key setup with GitHub, which is more secure than saving your GitHub credentials in your keychain. There are more details about setting up a public key on GitHub.com.

Fork this repository to your own GitHub account and clone it to your local machine.

Local development

To run the ActivityPub plugin in a local WordPress environment, you can use wp-env or Docker.

wp-env

wp-env lets you easily set up a local WordPress environment for building and testing plugins and themes. It’s simple to install and requires no configuration.

To get started, install wp-env by running the following command in the root of the ActivityPub plugin directory:

npm install

Then, start the local environment by running:

npm run env-start

This will start a local WordPress environment with the ActivityPub plugin installed and activated. You can open the WordPress site in your browser by visiting http://localhost.

To stop the environment, run:

npm run env-stop

Docker

If you prefer to use Docker, you can use the docker-compose.yml file in the root of the ActivityPub plugin directory.

To start the environment, run:

docker-compose up -d

This will start a local WordPress environment with the ActivityPub plugin installed and activated.

You can open the WordPress site in your browser by visiting http://localhost:8076.

Running Tests

You can now run the test suite using either npm or composer:

# Using npm
npm run env-start
npm run env-test

# Using composer
wp-env start
composer run test:wp-env

PHPUnit Arguments

Both commands support additional PHPUnit arguments. Add them after --:

# Run a specific test
npm run env-test -- --filter=test_migrate_to_4_1_0

# Run tests in a specific file
npm run env-test -- tests/includes/class-test-migration.php

# Run tests with a specific group
npm run env-test -- --group=migration

# Run tests with verbose output
npm run env-test -- --verbose

# The same works with composer
composer run test:wp-env -- --filter=test_migrate_to_4_1_0

Common PHPUnit arguments:

  • --filter: Run tests matching a pattern
  • --group: Run tests with a specific @group annotation
  • --exclude-group: Exclude tests with a specific @group annotation
  • --verbose: Output more verbose information
  • --debug: Display debugging information