search

front / wp-cli-build

Fetch specific versions of plugins/themes from wordpress.org using a build file
43 stars 7 forks source link
wordpress wp-cli

readme

WP-CLI Build

WP-CLI Build helps you to start your WP site in an organized way and simplifies maintenance: you don't need to version code that you don't maintain yourself like WP core, themes or 3rd party plugins. This makes it easy to have auto updates, without messing up your Git setup. WP-CLI Build is also useful for rebuilding your site after a hack. 

$ wp build

For more background, check out A Git Friendly Way to Handle WordPress Updates – Slides from WordCamp Oslo 2018

Getting Started

Prerequistes

This package requires WP-CLI v2.0 or greater. You can check WP-CLI version with $ wp --version and update to the latest stable release with $ wp cli update.

Installing

PHP 7.4: Install WP-CLI Build from our git repo

$ wp package install front/wp-cli-build

PHP 8.0: Install WP-CLI Build from our git repo

$ wp package install front/wp-cli-build:8.0.0

PHP 8.1: Install WP-CLI Build from our git repo

$ wp package install front/wp-cli-build:8.1.0

PHP 8.2: Install WP-CLI Build from our git repo

$ wp package install front/wp-cli-build:8.2.0

Note: The WP-CLI package installer will fail silently if your memory limit is too low. To see if installation was successful, run $ wp package list. If empty, locate your php.ini and increase the memory_limit.

Quick Start

The build file is the base of WP-CLI Build and will contain your WP site core configuration and the list of used public plugins and themes. The latest version of WP-CLI Build will generate a build.json file, but we still support build.yml, so you can use both.

To generate the build file you should run:

$ wp build-generate

It will also rewrite your .gitignore file to make sure only custom plugins and themes are indexed. Additionally, if there is a composer.json file present, any plugins or themes that are installed with Composer will be excluded from the "custom plugins and themes" section.

Bellow, you can see a sample of the WP-CLI BUILD BLOCK added to .gitignore:

# -----------------------------------------------------------------------------
# START WP-CLI BUILD BLOCK
# -----------------------------------------------------------------------------
# This block is auto generated every time you run 'wp build-generate'.
# Rules: Exclude everything from Git except for your custom plugins and themes
# (that is: those that are not on wordpress.org).
# -----------------------------------------------------------------------------
/*
!.gitignore
!.gitlab-ci.yml
!build.json
!composer.json
!README.md
!patches
!wp-content
wp-content/*
!wp-content/plugins
wp-content/plugins/*
!wp-content/themes
wp-content/themes/*
# -----------------------------------------------------------------------------
# Your custom plugins and themes.
# Added automagically by WP-CLI Build ('wp build-generate').
# -----------------------------------------------------------------------------
!wp-content/plugins/custom-plugin-slug/
!wp-content/themes/custom-theme-slug/
# -----------------------------------------------------------------------------
# END WP-CLI BUILD BLOCK
# -----------------------------------------------------------------------------

# -----------------------------------------------------------------------------
# START CUSTOM BLOCK
# -----------------------------------------------------------------------------
# Place any additional items here.
# -----------------------------------------------------------------------------
!custom-items
# -----------------------------------------------------------------------------
# END CUSTOM BLOCK
# -----------------------------------------------------------------------------

Note: Only active plugins and themes will be listed in build file and gitignore, unless you specify --all argument.

For more options, see $ wp build-generate --help

Using build file

You can run $ wp build to install the WordPress core of your site, 3rd party plugins and themes. It parses your build file, and works its magic!

A sample of a build.json file:

{
    "core": {
        "download": {
            "version": "~6.2.2",
            "locale": "en_US"
        }
    },
    "plugins": {
        "advanced-custom-fields": {
            "version": "*"
        },
        "timber-library": {
            "version": "^1.22.1"
        },
        "wordpress-seo": {
            "version": "*"
        }
    },
    "themes": {
        "twentytwentyone": {
            "version": "1.8"
        }
    }
}

A sample of a build.yml file:

core:
    download:
        version: "~6.2.2"
        locale: en_US
plugins:
    advanced-custom-fields
        version: "*"
    timber-library:
        version: "^1.22.1"
    wordpress-seo:
        version: "*"
themes:
    twentytwentyone:
        version: 1.8

Notice that you can use ~, * and ^ operators when you don't want to refer a fixed version.

Updating build and .gitignore

When you add a new plugin to your WP site, you should run $ wp build-generate to update build and .gitignore files.

For more options run $ wp --help build-generate and $ wp --help build

Clean install

Adding --clean option to $ wp build command forces all plugins to be deleted and downloaded again. It helps you make sure plugins are not corrupted.

Contributing

We appreciate you taking the initiative to contribute to this project!

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue with the following:

  1. What you were doing (e.g. "When I run wp build ...").
  2. What you saw (e.g. "I see a fatal about a class being undefined.").
  3. What you expected to see (e.g. "I expected to see the list of posts.")

Include as much detail as you can, and clear steps to reproduce if possible.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.