Skip to content

v4.2.0 — Remove child theme, versioned Erebus clone #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harryfinn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

v4.2.0 — Remove child theme, versioned Erebus clone #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ mkdir my-project && cd my-project
mimir
```

To check the currently installed version:
To use a specific Erebus version:

```bash
mimir --theme-version=3.1.0
```

To check the currently installed Mimir version:

```bash
mimir version
Expand All @@ -87,7 +93,7 @@ The interactive wizard walks through the following steps in order:
2. **Database configuration** — DB name, user, password, and host
3. **Site configuration** — URL, title, admin credentials
4. **WordPress core** — downloads core (`en_GB`), generates `wp-config.php`, creates the database, runs the install
5. **Theme setup** — clones Erebus as the parent theme, scaffolds a child theme with the correct `Template:` header
5. **Theme setup** — clones the tagged Erebus release into `wp-content/themes/erebus` and activates it
6. **Deploy workflow** — copies `deploy.yml` from the Mimir repo into `.github/workflows/`
7. **Git initialisation** — writes a `.gitignore`, makes the initial commit on `main`, optionally sets a remote and pushes
8. *(Placeholder)* Plugin installation
Expand Down Expand Up @@ -120,13 +126,11 @@ cd wp-content/themes/erebus

The following are planned additions. Each has a placeholder stub in `setup.sh` marked with a `TODO` comment.

- [ ] **Child theme scaffold** — `setup_themes()` generates placeholder `style.css`, `functions.php`, and `index.php` files. These need updating once the Erebus child theme approach is finalised (asset enqueuing, namespace setup, any required config files).

- [ ] **Plugin installation** — `setup_plugins()` is a stub. Implement a default plugin set installed and activated via `wp plugin install <slug> --activate`. Consider either a hardcoded list or a `plugins.json` config file for flexibility.

- [ ] **Settings configuration** — `setup_config()` is a stub. Implement optional WordPress settings (permalink structure, timezone, default post/comment settings, etc.) using `wp option update`.

- [ ] **Build dependencies** — `setup_build()` is a stub. Once the Erebus build tooling is confirmed, implement `yarn install` (and an optional initial build run) in both the parent and child theme directories.
- [ ] **Build dependencies** — `setup_build()` is a stub. Once the Erebus build tooling is confirmed, implement `yarn install` (and an optional initial build run) in the theme directory.

---

Expand Down
126 changes: 37 additions & 89 deletions setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ trap 'echo -e "\n \033[0;31m\033[1m✗ Setup failed on line ${LINENO}. See outp

# ─── Config ──────────────────────────────────────────────────────────────────

readonly MIMIR_VERSION="4.1.0"
readonly MIMIR_VERSION="4.2.0"
readonly MIMIR_REPO="thisisgain/Mimir"

readonly EREBUS_REPO="git@github.com:thisisgain/Erebus.git"
readonly EREBUS_THEME_DIR="wp-content/themes/erebus"
readonly EREBUS_VERSION="3.0.0"
readonly DEFAULT_ADMIN_EMAIL="harry.finn@thisisgain.com"
readonly DEFAULT_ADMIN_USER="super.user"
readonly DEFAULT_DB_HOST="127.0.0.1"
Expand Down Expand Up @@ -246,99 +247,34 @@ setup_core() {

# ─── Step 3: Theme setup ─────────────────────────────────────────────────────

CHILD_THEME_SLUG=""
# Set by --theme-version flag; falls back to EREBUS_VERSION constant.
THEME_VERSION_OVERRIDE=""

setup_themes() {
step "Theme setup"

CHILD_THEME_SLUG=$(ask_validated \
"Child theme slug (lowercase letters, numbers and hyphens)" \
"" \
"^[a-z0-9-]+$" \
"Use lowercase letters, numbers and hyphens only.")

local child_display
# Title-case the slug by default
child_display=$(echo "$CHILD_THEME_SLUG" | sed 's/-/ /g' | awk '{for(i=1;i<=NF;i++) $i=toupper(substr($i,1,1)) substr($i,2)}1')
child_display=$(ask "Theme display name" "$child_display")

local child_author
child_author=$(ask "Theme author" "GAIN")

# Clone Erebus parent
if [[ -d "$EREBUS_THEME_DIR" ]]; then
success "Erebus parent theme already present, skipping clone"
local erebus_tag
if [[ -n "$THEME_VERSION_OVERRIDE" ]]; then
erebus_tag=$(normalise_version "$THEME_VERSION_OVERRIDE")
else
info "Cloning Erebus parent theme from ${EREBUS_REPO}..."
git clone "$EREBUS_REPO" "$EREBUS_THEME_DIR"
rm -rf "${EREBUS_THEME_DIR}/.git"
success "Erebus cloned to ${EREBUS_THEME_DIR}"
erebus_tag="v${EREBUS_VERSION}"
fi

# Generate child theme scaffold
local child_dir="wp-content/themes/${CHILD_THEME_SLUG}"
if [[ -d "$child_dir" ]]; then
success "Child theme '${CHILD_THEME_SLUG}' already exists, skipping scaffold"
if [[ -d "$EREBUS_THEME_DIR" ]]; then
success "Erebus already present at ${EREBUS_THEME_DIR}, skipping clone"
else
mkdir -p "$child_dir"

# style.css — WordPress reads theme metadata from here
cat > "${child_dir}/style.css" << CSS
/*
Theme Name: ${child_display}
Theme URI: https://thisisgain.com
Author: ${child_author}
Description: ${child_display} — child theme built on Erebus
Template: erebus
Version: 1.0.0
Text Domain: ${CHILD_THEME_SLUG}
*/

/*
* TODO: Update child theme approach once finalised in Erebus.
* Add project-specific overrides here; avoid duplicating parent styles.
*/
CSS

# functions.php — enqueue parent styles, placeholder for further setup
cat > "${child_dir}/functions.php" << 'PHP'
<?php

/**
* Enqueue parent and child theme stylesheets.
*
* TODO: Update once the Erebus build process is confirmed. If the parent
* theme compiles its own CSS, enqueue that compiled asset rather than
* the raw style.css below.
*/
add_action( 'wp_enqueue_scripts', function () {
wp_enqueue_style(
'erebus-style',
get_template_directory_uri() . '/style.css',
[],
wp_get_theme( 'erebus' )->get( 'Version' )
);

wp_enqueue_style(
'erebus-child-style',
get_stylesheet_uri(),
[ 'erebus-style' ],
wp_get_theme()->get( 'Version' )
);
} );
PHP

# index.php — required by WordPress theme standards
echo "<?php // Silence is golden." > "${child_dir}/index.php"

success "Child theme scaffold created at ${child_dir}"
info "Cloning Erebus ${erebus_tag}..."
git clone --branch "$erebus_tag" --depth 1 "$EREBUS_REPO" "$EREBUS_THEME_DIR" \
|| error "Could not clone Erebus ${erebus_tag}. Check the tag exists: https://github.com/thisisgain/Erebus/releases"
rm -rf "${EREBUS_THEME_DIR}/.git"
success "Erebus ${erebus_tag} cloned to ${EREBUS_THEME_DIR}"
fi

if wp theme is-active "$CHILD_THEME_SLUG" &>/dev/null; then
success "Child theme '${CHILD_THEME_SLUG}' already active, skipping"
if wp theme is-active erebus &>/dev/null; then
success "Erebus already active, skipping"
else
wp theme activate "$CHILD_THEME_SLUG"
success "Child theme '${CHILD_THEME_SLUG}' activated"
wp theme activate erebus
success "Erebus theme activated"
fi
}

Expand Down Expand Up @@ -480,7 +416,7 @@ print_summary() {
echo -e " ${BOLD}WP Admin:${RESET} ${SITE_URL}/wp-admin"
echo -e " ${BOLD}Admin user:${RESET} ${ADMIN_USER}"
echo -e " ${BOLD}Admin password:${RESET} ${ADMIN_PASSWORD}"
echo -e " ${BOLD}Child theme:${RESET} ${CHILD_THEME_SLUG}"
echo -e " ${BOLD}Theme:${RESET} Erebus v${THEME_VERSION_OVERRIDE:-$EREBUS_VERSION}"
echo ""
echo -e " ${YELLOW}Note: wp-config.php is excluded from git. Add it manually${RESET}"
echo -e " ${YELLOW}per environment (e.g. via WP Engine SSH access).${RESET}"
Expand Down Expand Up @@ -565,11 +501,14 @@ usage() {
Mimir v${MIMIR_VERSION} — GAIN WordPress Project Setup

Usage:
mimir Run the interactive setup wizard
mimir version Print the installed Mimir version
mimir update-cli Update to the latest release
mimir update-cli --version=4.1.0 Update to a specific version
mimir --help Show this help text
mimir Run the interactive setup wizard
mimir --theme-version=3.1.0 Use a specific Erebus version
mimir version Print the installed Mimir version
mimir update-cli Update to the latest Mimir release
mimir update-cli --version=4.2.0 Update to a specific Mimir version
mimir --help Show this help text

Default Erebus version: ${EREBUS_VERSION}

Prerequisites:
- WP-CLI (https://wp-cli.org)
Expand All @@ -592,6 +531,15 @@ main() {
update-cli) update_cli "${@:2}" ;;
esac

# Parse setup flags
while [[ $# -gt 0 ]]; do
case "$1" in
--theme-version=*) THEME_VERSION_OVERRIDE="${1#--theme-version=}"; shift ;;
--theme-version) THEME_VERSION_OVERRIDE="${2:-}"; shift 2 ;;
*) shift ;;
esac
done

banner
check_requirements
setup_core
Expand Down