From 10677e279e1f10fd82567f9bb7ac870d685bc5df Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Mon, 21 Jun 2021 00:39:14 +0100 Subject: [PATCH 1/6] Add CI build script ....unfortunately my CI server is down right now though, so we're still running it manually for now. --- .docs/package.json | 3 +- build.sh | 165 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 167 insertions(+), 1 deletion(-) create mode 100755 build.sh diff --git a/.docs/package.json b/.docs/package.json index 61199d1..a67a1ec 100644 --- a/.docs/package.json +++ b/.docs/package.json @@ -6,7 +6,8 @@ "private": true, "scripts": { "test": "echo \"No tests have been implemented yet\"", - "start": "npx @11ty/eleventy --serve" + "start": "npx @11ty/eleventy --serve", + "build": "npx @11ty/eleventy" }, "repository": { "type": "git", diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..ea083f7 --- /dev/null +++ b/build.sh @@ -0,0 +1,165 @@ +#!/usr/bin/env bash +set -e; + +# ██████ ██ ██████ ██ ██ ██ ██ ██████ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ██ ██ ██████ ██ ██ ██ ██ ██ ██ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ██████ ██ ██████ ██████ ██ ███████ ██████ + +# This script's purpose is to execute CI build tasks for WorlEditAdditions. +# +# Currently this involves building the website & uploading it to the web +# server (though the upload obviously requires an SSH key). +# +# You do NOT need to run this script to use WorldEditAdditions - only to build +# the website. + +# If you try and submit malware to this file, you WILL receive a PERMANENT BAN, +# and I WILL report you to all the places I possibly can. + +deploy_ssh_user="ci"; +deploy_ssh_host="starbeamrainbowlabs.com"; +deploy_ssh_port="2403"; + +deploy_root_dir="WorldEditAdditions"; + +# Make sure $WORKSPACE is set to ensure compatilibity with a regular shell +# This is important until we get our CI server back up and running +WORKSPACE="${WORKSPACE:-$PWD}"; + +############################################################################### + +log_msg() { + echo "[ $SECONDS ] >>> $*" >&2; +} + +# $1 - Command name to check for +check_command() { + set +e; + which $1 >/dev/null 2>&1; exit_code=$? + if [[ "${exit_code}" -ne 0 ]]; then + log_msg "Error: Couldn't locate $1. Make sure it's installed and in your path."; + fi + set -e; +} + +############################################################################### + +log_msg "WorldEditAdditions build script starting"; +log_msg "You do NOT need to run this script to use WorldEditAdditions - this script is for my Continuous Integration server to build and deploy the website :-)"; + +check_command node; +check_command npm; +check_command npx; +check_command cat; +check_command sftp; +check_command lftp; + +if [[ -z "${SSH_KEY_PATH}" ]]; then + echo "Error: SSH_KEY_PATH environment variable is not set."; + exit 1; +fi + +temp_dir="$(mktemp --tmpdir -d "WorldEditAdditions-XXXXXXX")"; +on_exit() { + rm -rf "${temp_dir}"; +} +trap on_exit EXIT; + +############################################################################### + + +cd "./.docs" || { echo "Failed to cd into ./.docs"; exit 1; }; + +# ██████ ██ ██ ██ ██ ██████ +# ██ ██ ██ ██ ██ ██ ██ ██ +# ██████ ██ ██ ██ ██ ██ ██ +# ██ ██ ██ ██ ██ ██ ██ ██ +# ██████ ██████ ██ ███████ ██████ + +log_msg "Installing website dependencies"; + +npm install; + +log_msg "Building website"; + +npm run build; + +if [[ ! -d "_site" ]]; then + log_msg "Error: No website build output generated (eh?)"; + exit 1; +fi + + +# █████ ██████ ██████ ██ ██ ██ ██ ██ ███████ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ███████ ██████ ██ ███████ ██ ██ ██ █████ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ██ ██ ██ ██ ██████ ██ ██ ██ ████ ███████ + +if [[ ! -z "${ARCHIVE}" ]]; then + log_msg "Archiving content"; + check_command tar; + check_command gzip; + + cd "_site" || { echo "Failed to cd into _site"; exit 1; }; + + tar -caf "${ARCHIVE}/WorldEditAdditions-website.tar.gz" .; + + log_msg "Archived to ${ARCHIVE}/WorldEditAdditions-website.tar.gz:"; + ls -lh "${ARCHIVE}/WorldEditAdditions-website.tar.gz"; + + cd ".." || { echo "Failed to parent directory again"; exit 1; }; +fi + + +# ██ ██ ██████ ██ ██████ █████ ██████ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ██ ██ ██████ ██ ██ ██ ███████ ██ ██ +# ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ██████ ██ ███████ ██████ ██ ██ ██████ + +log_msg "Acquiring upload lock"; +# Acquire an exclusive project-wide lock so that we only upload stuff one-at-a-time +exec 9<"${WORKSPACE}"; +flock --exclusive 9; + +log_msg "Deploying to server"; + +# Actions: +# [sftp] 1. Connect to remote server +# [sftp] 2. Upload new files +# [lftp] 4. Swap in new directory +# [lftp] 5. Delete old directory + +sftp -i "${SSH_KEY_PATH}" -P "${deploy_ssh_port}" -o PasswordAuthentication=no "${deploy_ssh_user}@${deploy_ssh_host}" << SFTPCOMMANDS +mkdir ${deploy_root_dir}/www-new +put -r _site/* ${deploy_root_dir}/www-new +bye +SFTPCOMMANDS + +lftp_commands_filename="${temp_dir}/commands.lftp"; + +( + echo "set sftp:connect-program 'ssh -x -i ${SSH_KEY_PATH}'"; + # We have an extra : before the @ here to avoid the password prompt + echo "connect sftp://${deploy_ssh_user}:@${deploy_ssh_host}:${deploy_ssh_port}"; + + echo "mv \"${deploy_root_dir}/www\" \"${deploy_root_dir}/www-old\""; + echo "mv \"${deploy_root_dir}/www-new\" \"${deploy_root_dir}/www\""; + echo "rm -r \"${deploy_root_dir}/www-old\""; + echo "bye"; +) >"${lftp_commands_filename}"; + + +lftp --version; +cat "${lftp_commands_filename}"; +lftp -f "${lftp_commands_filename}"; +exit_code=$? + +log_msg "Releasing lock"; +exec 9>&- # Close file descriptor 9 and release the lock + + +log_msg "Complete!"; From 96a645c5461f0590b297d20aca95fb3457360bac Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Mon, 21 Jun 2021 00:52:29 +0100 Subject: [PATCH 2/6] docs: Add favicon, twitteer cards etc, theme colour, hyperlink to title --- .docs/_includes/theme.njk | 24 ++++++++++++++++++++++-- .docs/css/theme.css | 2 +- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/.docs/_includes/theme.njk b/.docs/_includes/theme.njk index f00aae7..6ecd84f 100644 --- a/.docs/_includes/theme.njk +++ b/.docs/_includes/theme.njk @@ -5,13 +5,33 @@ {{ title }} • WorldEditAdditions + + + + + + + + + + + + + + + + + + + +