Feature/add more flexibility

packages/toolkit/PROJECTS.md

@@ -73,7 +73,7 @@ The project subcommand provides a variety of utlities for creating, building, an
 List of commands:
 
 ```bash
-10up-toolkit project init [<path>] [--template=<Git repository>] [--name=<Project Name>] [--confirm] [--skip-composer]
+10up-toolkit project init [--path=<path>] [--template=<Git repository>] [--name=<Project Name>] [--confirm] [--skip-composer]
 ```
 
 `init` creates a project. You can optionally provide it a number of parameters or answer the prompts. If no path is provided, it will initialize the project in the current directory. You will be prompted to choose a template e.g. [WP Scaffold](https://github.com/10up/wp-scaffold). Init will automatically search and replace prefixes using the project name you provide.
@@ -85,15 +85,21 @@ List of commands:
 `build` simply executes your `scripts/build.sh` file (or other path you specify). `build` will be executed before deploying files.
 
 ```bash
-10up-toolkit project create-payload <branch>
+10up-toolkit project create-payload
 ```
 
-This command creates a payload directory of the built project (including WordPress) for deployment. Engineers likely won't need to run this command themselves as GitLab does it automatically. You must provide a branch that corresponds to an environment in `.tenup.yml`.
+This command performs a simulated CI/CD build and creates a payload directory of the built project (including WordPress core). Useful for validating how a build will behave in CI/CD for deployment. Engineers likely won't need to run this command themselves as CI/CD does it automatically.
 
 ```bash
 10up-toolkit project generate-ci [--confirm] [--path=<path>]
 ```
 
 This command generates necessary CI files. For GitLab, this would be `.gitlab-ci.yml`. Right now this only supports GitLab but we will add support for GitHub in the future.
 
+```bash
+10up-toolkit project update-composer
+```
+
+Convenience function to update all dependencies in all found composer.json files. Also generates updated lock files.
+
 **Note that generating CI files is currently in alpha and may require manual editing to fix issues.**

packages/toolkit/project/gitlab/.gitlab-ci.tmpl

@@ -25,7 +25,7 @@ build_plugins_and_themes:
   stage: build
   script:
     - nvm install 18
-    - npx 10up-toolkit project create-payload $CI_COMMIT_REF_NAME
+    - npx 10up-toolkit project create-payload
   artifacts:
     paths:
       - payload

packages/toolkit/project/gitlab/deploy-configs/pantheon-production.tmpl

@@ -7,7 +7,7 @@ deploy_production:
     MULTI_DEV_ENVIRONMENT: "{{branch}}"
     WORDPRESS_VERSION: {{wordpress_version}}
     GIT_URL: {{deploy_to}}
-    EXCLUDES: {{deploy_file_excludes}}
+    EXCLUDES: {{rsync_file_excludes}}
   allow_failure: false
   only:
     refs:

packages/toolkit/project/gitlab/deploy-configs/pantheon-staging.tmpl

@@ -7,7 +7,7 @@ deploy_{{branch}}:
     MULTI_DEV_ENVIRONMENT: "{{branch}}"
     WORDPRESS_VERSION: {{wordpress_version}}
     GIT_URL: {{deploy_to}}
-    EXCLUDES: {{deploy_file_excludes}}
+    EXCLUDES: {{rsync_file_excludes}}
   allow_failure: false
   only:
     refs:

packages/toolkit/project/gitlab/deploy-configs/rsync-production.tmpl

@@ -7,7 +7,7 @@ deploy_production:
   variables:
     DESTINATION: {{deploy_to}}
     SUBDIR: {{deploy_to_subdir}}
-    EXCLUDES: {{deploy_file_excludes}}
+    EXCLUDES: {{rsync_file_excludes}}
   only:
     refs:
       - {{branch}}

packages/toolkit/project/gitlab/deploy-configs/rsync-staging.tmpl

@@ -7,7 +7,7 @@ deploy_{{branch}}:
   variables:
     DESTINATION: {{deploy_to}}
     SUBDIR: {{deploy_to_subdir}}
-    EXCLUDES: {{deploy_file_excludes}}
+    EXCLUDES: {{rsync_file_excludes}}
   only:
     refs:
       - {{branch}}

packages/toolkit/project/local/.gitignore

@@ -0,0 +1,26 @@
+payload
+build/vendor
+build/composer.lock
+build/composer.json
+/vendor
+wordpress/.env
+wordpress/*php
+wordpress/wp-content/uploads
+wordpress/wp-includes
+wordpress/wp-admin
+wordpress/license.txt
+wordpress/readme.html
+!wordpress/wp-config.php
+docker-compose.override.yml
+.config.json
+wordpress/wp-content/advanced-cache.php
+wordpress/wp-content/mu-plugins/10up-experience.php
+wordpress/wp-content/mu-plugins/10up-experience/
+wordpress/wp-content/mu-plugins/batcache.php
+wordpress/wp-content/mu-plugins/batcache/
+wordpress/wp-content/mu-plugins/redis-cache.php
+wordpress/wp-content/mu-plugins/redis-cache/
+wordpress/wp-content/mu-plugins/s3-uploads.php
+wordpress/wp-content/mu-plugins/s3-uploads/
+wordpress/wp-content/object-cache.php
+.lock

packages/toolkit/project/local/scripts/build.sh

@@ -1,5 +1,18 @@
-# Add builds scripts here. This script will be run from the root of your project (same directory as .tenup.yml).
+#!/usr/bin/env bash -l
+# NOTE: you should keep the above line, at line 1. Only modify if you know what you are doing.
 
-nvm install
-node -v
-npm install
+# You should use npx 10up-toolkit build to build your project. When you do, there are a number of things
+# you get "for free" including nvm handling and the basics of building are handled automatically. You
+# only need to provide additional build routines if the default build system doesn't quite get things
+# right. Adding build scripts is easy. Create as many .sh files as you need in this scripts directory.
+
+# Here is an example script you can use to get you started It assumes you are using a "modern" layout.
+
+# change directories to your theme or plugin
+pushd .
+
+# run your build commands
+echo "Hello World!"
+
+# return to where we were so the next build script starts off from the same place
+popd

packages/toolkit/scripts/project/bash/Dockerfile

@@ -0,0 +1,7 @@
+FROM alpine:latest
+
+USER root
+WORKDIR /var/www/html
+COPY payload .
+RUN mkdir wp-content/uploads && \
+    chown 33:33 wp-content/uploads

packages/toolkit/scripts/project/bash/build-setup.sh

@@ -1,13 +1,245 @@
-#!/bin/bash
+#!/usr/bin/env bash -l
 
-maybe_init_nvm() {
+SHARE_DIR="$(dirname "$(realpath "$0")")"
+# Various tasks to determine some things like what kind of project is this
+# such as standard, wp-content rooted...something else?
+function build:preflight {
+  PROJECT_TYPE="standard"
+  # Check for a default, standard layout that has a wordpress directory
+  if [ -d wordpress ] && [ -d build ]; then # this is probably a standard setup
+    echo "Detected standard WordPress repository layout"
 
-  if [ $(find . -name .nvmrc | wc -l) -gt 0 ] && [ ! -f $NVM_DIR/nvm.sh ]; then
-    echo "This project requires nvm. Please install nvm and try again"
+    WORDPRESS_BUILD_ROOT="wordpress/wp-content"
+    return
+  fi
+
+  # Check for a wp-content rooted style repository
+  if [ -d plugins ] || [ -d themes ]; then # this is probably a wp-root repo
+    echo "Detected wp-content rooted WordPress repository layout"
+    PROJECT_TYPE="wpcontent"
+    WORDPRESS_BUILD_ROOT="."
+    return
+  fi
+
+}
+
+
+# Routine to determine what version of WordPress to install
+function build:version {
+
+  WORDPRESS_VERSION="latest"
+  if [ ${CI:-false} = "true" ]; then
+    if [ -z ${WORDPRESS_VERSION} ]; then
+      WORDPRESS_VERSION="latest"
+    fi
+  else
+    GIT_BRANCH=$(git branch --format='%(refname:short)' --show-current)
+    GIT_BRANCH_SLUG=$(utilities:create-gitlab-slug ${GIT_BRANCH})
+    ENVIRONMENT=$(yq eval '.environments | to_entries[] | select(.value.branch == "'${GIT_BRANCH_SLUG}'") | .key' ${TENUP_CI_FILE})
+
+    if [ ${ENVIRONMENT:-null} != "null" ]; then
+      WORDPRESS_VERSION=$(yq '.environments.'${ENVIRONMENT}'.wordpress_version' ${TENUP_CI_FILE})
+    fi
+  fi
+
+  if [ "${WORDPRESS_VERSION}" == "latest" ]; then
+    WORDPRESS_VERSION=$(curl -s https://api.wordpress.org/core/version-check/1.7/ | jq '.offers[0].current' | tr -d '"')
+  fi
+
+  echo ${WORDPRESS_VERSION}
+}
+
+function build:install {
+  build:preflight
+
+  # we use command in case wp-cli is installed as an alias
+  if [[ -z $(command -v wp) ]]; then
+    echo "wp-cli is not installed or in your path but it is required"
+    exit 1
+  fi
+
+  local WORDPRESS_VERSION=$(build:version)
+  echo "Installing WordPress version: ${WORDPRESS_VERSION}"
+
+  if [ ${PROJECT_TYPE} = "standard" ]; then
+    mkdir -p wordpress/wp-content
+    pushd wordpress
+  else
+    mkdir -p payload/wp-content
+    pushd payload
+  fi
+  wp core download --version=${WORDPRESS_VERSION} --skip-content --force
+  popd
+
+}
+
+function build:main {
+  set -eo pipefail
+
+  build:preflight
+
+  # don't call this script directly
+  if [ $(shopt -q login_shell) ]; then
+    echo "Please call this using build/local.sh rather than directly"
     exit 1
   fi
 
-  . $NVM_DIR/nvm.sh
+  # This is your "main" build file. By default, it builds a 10up/wp-scaffold style project
+  # but you are free to modify it as required for your project. Remember, you can also
+  # drop in any number of scripts and they will be run in alphabetical order AFTER main.sh
+
+  # detect if this is a standard layout or not
+
+  if [ -d wordpress/wp-content ]; then
+    pushd wordpress/wp-content
+  elif [ -d plugins ]; then
+    pushd . # go no where, we are already in the right spot
+  fi
+  if [ "${CI:-false}" = "true" ] && [ -f composer.json ]; then
+    if [ ! -f composer.lock ] && [ -f composer.json ]; then
+      echo "No composer.lock file detected. You should create/commit an up to date composer.lock file!"
+      exit 1
+    else
+      composer install --no-dev
+    fi
+  elif [ -f composer.json ]; then
+    composer install
+  fi
+
+
+  if [ -f package.json ]; then
+    # Ensure we have the correct node version installed
+    nvm install
+    nvm use
+
+    if [ "${CI:-false}" = "true" ] && [ -f package.json ]; then
+      if [ -f package-lock.json ]; then
+        npm ci
+      else
+        echo "No package-lock.json file detected. You should create/commit an up to date package-lock.json file!"
+        exit 1
+      fi
+    else
+      npm install
+    fi
+
+    npm run build
+  fi
+  popd
+}
+
+function build:local {
+  set -eo pipefail
+  # Create additional build scripts in the build directory with a .sh
+  # extension. They should do their work inside the wordpress directory.
+
+  # We always call main.sh first
+  build:preflight
+  build:main
+
+  # Then call any other drop in scripts next
+  for I in $(ls scripts/*sh)
+  do
+    . $I
+  done
+}
+
+# Perform a CI like build
+function build:full {
+  set -eo pipefail
+
+  build:preflight
+  build:install
+  build:local
+
+  # This rsync will typically work but if you have integrated the CI Library
+  # into a non project template based project you should adjust it
+
+  # First determine if we are using a project rsync-exclude or the included one
+  if [ -f scripts/rsync-excludes.txt ]; then
+    RSYNC_EXCLUDES="scripts/rsync-excludes.txt"
+  fi
+
+  if [ ${PROJECT_TYPE} == "standard" ]; then
+    rsync -a --exclude-from=${RSYNC_EXCLUDES} wordpress/ payload/
+  else
+    for I in themes mu-plugins plugins
+    do
+      if [ -d $I ]; then
+        rsync -a --exclude-from=${RSYNC_EXCLUDES} $I/ payload/wp-content/$I
+      fi
+    done
+  fi
+
+}
+
+function build:update-composer {
+
+  build:preflight
+
+  if [ ${PROJECT_TYPE} == "standard" ]; then
+    pushd wordpress/wp-content
+  else
+    pushd .
+  fi
+
+  if [ ! composer.json ]; then
+    echo "No composer.json file found. Run this from the root of a project and try again."
+    exit 1
+  fi
+
+  for I in $(find . -maxdepth 1 -name composer.json)
+  do
+    composer update --no-install
+  done
+
+  pushd themes
+  for I in $(find . -maxdepth 2 -name composer.json)
+  do
+    pushd $(dirname $I)
+    composer update --no-install
+    popd
+  done
+
+  popd
+  popd
+}
+
+function build:initialize-git {
+  git init .
+  echo
+  echo
+  echo 'Git has been initialized. Please run "git remote add origin <project git url>" to set the remote repository location.'
+}
+
+function build:package {
+
+  if [ -z $(which docker) ]; then
+    echo "You don't seem to have Docker installed but it is required for this to work."
+    exit 1
+  fi
+
+  if [ ! -d payload ]; then
+    echo "No payload directory found. Please run 10up-toolkit project create-payload first."
+    exit 1
+  fi
+
+  # First determine if we are using a project Dockerfile or the included one
+  if [ -f Dockerfile ]; then
+    DOCKERFILE="Dockerfile"
+  else
+    DOCKERFILE="${SHARE_DIR:?}/Dockerfile"
+  fi
+   # FIXME: This should be updated to use variables from .tenup-ci.yml
+  docker buildx build --load -f ${DOCKERFILE} . -t tenup-project:latest
+}
+
+
+# Converts a git branch to a gitlab compatible slug
+function utilities:create-gitlab-slug {
+  local VALUE=$(echo $1 | sed 's/[^a-zA-Z0-9]/-/g' | awk '{print tolower($0)}')
+
+  echo ${VALUE}
 }
 
-maybe_init_nvm
+eval build:$@

packages/toolkit/scripts/project/bash/create-payload.sh

@@ -17,4 +17,4 @@ download https://wordpress.org/wordpress-${WORDPRESS_VERSION}.tar.gz wordpress.t
 tar --strip-components=1 -zxmf wordpress.tar.gz -C .
 rm wordpress.tar.gz
 
-rsync -avz --exclude-from=$deploy_file_excludes_absolute $project_root/$deploy_from $deploy_to_subdir
+rsync -avz --exclude-from=$rsync_file_excludes_absolute $project_root/$deploy_from $deploy_to_subdir