feat: import zola helper scripts
This commit is contained in:
parent
3f3e53162c
commit
de93ced4c4
GPG key ID:
AD9F0F08E855ED88
6 changed files with 437 additions and 7 deletions
|
|
@ -1,2 +1,27 @@
|
||||||
defaut:
|
default: ## Build the website
|
||||||
|
./scripts/spellcheck.sh --check
|
||||||
./scripts/prep.sh
|
./scripts/prep.sh
|
||||||
|
./scripts/zola.sh build
|
||||||
|
|
||||||
|
clean: ## Clean build assets
|
||||||
|
./scripts/zola.sh clean
|
||||||
|
|
||||||
|
ci-deploy: ## Deploy from CI/CD. Only call from within CI
|
||||||
|
@if [ "${CI}" != "woodpecker" ]; \
|
||||||
|
then echo "Only call from within CI. Will re-write your local Git configuration. To override, set export CI=woodpecker"; \
|
||||||
|
exit 1; \
|
||||||
|
fi
|
||||||
|
git config --global user.email "${CI_COMMIT_AUTHOR_EMAIL}"
|
||||||
|
git config --global user.name "${CI_COMMIT_AUTHOR}"
|
||||||
|
./scripts/zola.sh deploy pages public "${CI_COMMIT_AUTHOR} <${CI_COMMIT_AUTHOR_EMAIL}>"
|
||||||
|
./scripts/ci.sh --init "$$REPO_WRITE_DEPLOY_KEY"
|
||||||
|
./scripts/ci.sh --clean
|
||||||
|
|
||||||
|
env: ## Download build dependencies and setup dev environment
|
||||||
|
./scripts/zola.sh install
|
||||||
|
|
||||||
|
help: ## Prints help for targets with comments
|
||||||
|
@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
||||||
|
|
||||||
|
serve: ## Serve website during development
|
||||||
|
./scripts/zola.sh zola -- serve
|
||||||
|
|
|
||||||
95
website/scripts/ci.sh
Executable file
95
website/scripts/ci.sh
Executable file
|
|
@ -0,0 +1,95 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# ci.sh: Helper script to automate deployment operations on CI/CD
|
||||||
|
# Copyright © 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
set -xEeuo pipefail
|
||||||
|
#source $(pwd)/scripts/lib.sh
|
||||||
|
|
||||||
|
readonly SSH_ID_FILE=/tmp/ci-ssh-id
|
||||||
|
readonly SSH_REMOTE_NAME=origin-ssh
|
||||||
|
|
||||||
|
match_arg() {
|
||||||
|
if [ $1 == $2 ] || [ $1 == $3 ]
|
||||||
|
then
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
help() {
|
||||||
|
cat << EOF
|
||||||
|
USAGE: ci.sh [SUBCOMMAND]
|
||||||
|
Helper script to automate deployment operations on CI/CD
|
||||||
|
|
||||||
|
Subcommands
|
||||||
|
|
||||||
|
-c --clean cleanup secrets, SSH key and other runtime data
|
||||||
|
-i --init <SSH_PRIVATE_KEY> initialize environment, write SSH private to file
|
||||||
|
-h --help print this help menu
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
# $1: SSH private key
|
||||||
|
write_ssh(){
|
||||||
|
truncate --size 0 $SSH_ID_FILE
|
||||||
|
echo "$1" > $SSH_ID_FILE
|
||||||
|
chmod 600 $SSH_ID_FILE
|
||||||
|
}
|
||||||
|
|
||||||
|
set_ssh_remote() {
|
||||||
|
http_remote_url=$(git remote get-url origin)
|
||||||
|
remote_hostname=$(echo $http_remote_url | cut -d '/' -f 3)
|
||||||
|
repository_owner=$(echo $http_remote_url | cut -d '/' -f 4)
|
||||||
|
repository_name=$(echo $http_remote_url | cut -d '/' -f 5)
|
||||||
|
ssh_remote="git@$remote_hostname:$repository_owner/$repository_name"
|
||||||
|
ssh_remote="git@codeberg.org:SocialCoding/gitea-open-letter.git"
|
||||||
|
git remote add $SSH_REMOTE_NAME $ssh_remote
|
||||||
|
}
|
||||||
|
|
||||||
|
clean() {
|
||||||
|
if [ -f $SSH_ID_FILE ]
|
||||||
|
then
|
||||||
|
shred $SSH_ID_FILE
|
||||||
|
rm $SSH_ID_FILE
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
if (( "$#" < 1 ))
|
||||||
|
then
|
||||||
|
help
|
||||||
|
exit -1
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
if match_arg $1 '-i' '--init'
|
||||||
|
then
|
||||||
|
if (( "$#" < 2 ))
|
||||||
|
then
|
||||||
|
help
|
||||||
|
exit -1
|
||||||
|
fi
|
||||||
|
set_ssh_remote
|
||||||
|
write_ssh "$2"
|
||||||
|
elif match_arg $1 '-c' '--clean'
|
||||||
|
then
|
||||||
|
clean
|
||||||
|
elif match_arg $1 '-h' '--help'
|
||||||
|
then
|
||||||
|
help
|
||||||
|
else
|
||||||
|
help
|
||||||
|
fi
|
||||||
32
website/scripts/lib.sh
Executable file
32
website/scripts/lib.sh
Executable file
|
|
@ -0,0 +1,32 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Copyright © 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
check_arg(){
|
||||||
|
if [ -z $1 ]
|
||||||
|
then
|
||||||
|
help
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
match_arg() {
|
||||||
|
if [ $1 == $2 ] || [ $1 == $3 ]
|
||||||
|
then
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
@ -1,11 +1,33 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
# prep.sh: Helper script to convert README.md in to zola index page content
|
||||||
|
# Copyright © 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
readonly file="content/letter.md"
|
readonly file="content/letter.md"
|
||||||
|
|
||||||
rm -rf $file || true
|
set -euo pipefail
|
||||||
|
|
||||||
touch $file
|
init() {
|
||||||
echo "+++" > $file
|
rm -rf $file || true
|
||||||
echo 'title = "Gitea Open Letter"' >> $file
|
|
||||||
echo "+++" >> $file
|
touch $file
|
||||||
cat ../README.md | tail -n +5 >> $file
|
echo "+++" > $file
|
||||||
|
echo 'title = "Gitea Open Letter"' >> $file
|
||||||
|
echo "+++" >> $file
|
||||||
|
echo "" >> $file
|
||||||
|
cat ../README.md | tail -n +5 >> $file
|
||||||
|
}
|
||||||
|
|
||||||
|
init
|
||||||
|
|
|
||||||
98
website/scripts/spellcheck.sh
Executable file
98
website/scripts/spellcheck.sh
Executable file
|
|
@ -0,0 +1,98 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Used in CI workflow: install and check for spelling errors
|
||||||
|
# Copyright © 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
readonly MISSPELL_DOWNLOAD="https://github.com/client9/misspell/releases/download/v0.3.4/misspell_0.3.4_linux_64bit.tar.gz"
|
||||||
|
readonly TMP_DIR=$(pwd)/tmp
|
||||||
|
readonly PROJECT_ROOT=$(pwd)
|
||||||
|
readonly MISSPELL_TARBALL="$TMP_DIR/misspell.tar.bz2"
|
||||||
|
readonly MISSPELL="$TMP_DIR/misspell"
|
||||||
|
|
||||||
|
set -Eeuo pipefail
|
||||||
|
|
||||||
|
source $(pwd)/scripts/lib.sh
|
||||||
|
|
||||||
|
FLAGS=""
|
||||||
|
|
||||||
|
help() {
|
||||||
|
cat << EOF
|
||||||
|
spellcheck.sh: Check for spelling errors
|
||||||
|
USAGE:
|
||||||
|
spellcheck.sh <options>
|
||||||
|
OPTIONS:
|
||||||
|
c --check check for spelling erros
|
||||||
|
h --help print this help menu
|
||||||
|
w --write check and fix spelling errors
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
download() {
|
||||||
|
if [ ! -e $MISSPELL ];
|
||||||
|
then
|
||||||
|
echo "[*] Downloading misspell"
|
||||||
|
wget --quiet --output-doc=$MISSPELL_TARBALL $MISSPELL_DOWNLOAD;
|
||||||
|
cd $TMP_DIR
|
||||||
|
tar -xf $MISSPELL_TARBALL;
|
||||||
|
cd $PROJECT_ROOT
|
||||||
|
pip install codespell
|
||||||
|
else
|
||||||
|
echo "[*] Found misspell"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
spell_check_codespell() {
|
||||||
|
_check(){
|
||||||
|
codespell $FLAGS $PROJECT_ROOT/$1 #|| true
|
||||||
|
}
|
||||||
|
_check README.md
|
||||||
|
_check contents
|
||||||
|
}
|
||||||
|
|
||||||
|
spell_check_misspell() {
|
||||||
|
mkdir $TMP_DIR || true
|
||||||
|
download
|
||||||
|
|
||||||
|
_check(){
|
||||||
|
$MISSPELL $FLAGS $PROJECT_ROOT/$1
|
||||||
|
}
|
||||||
|
|
||||||
|
_check contents
|
||||||
|
_check README.md
|
||||||
|
}
|
||||||
|
|
||||||
|
check_arg $1
|
||||||
|
|
||||||
|
if match_arg $1 'w' '--write'
|
||||||
|
then
|
||||||
|
echo "[*] checking and correcting spellings"
|
||||||
|
FLAGS="-w"
|
||||||
|
spell_check_misspell
|
||||||
|
spell_check_codespell
|
||||||
|
elif match_arg $1 'c' '--check'
|
||||||
|
then
|
||||||
|
echo "[*] checking spellings"
|
||||||
|
spell_check_misspell
|
||||||
|
spell_check_codespell
|
||||||
|
elif match_arg $1 'h' '--help'
|
||||||
|
then
|
||||||
|
help
|
||||||
|
else
|
||||||
|
echo "undefined option"
|
||||||
|
help
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
158
website/scripts/zola.sh
Executable file
158
website/scripts/zola.sh
Executable file
|
|
@ -0,0 +1,158 @@
|
||||||
|
#!/bin/bash
|
||||||
|
# Used in CI workflow: install Zola binary from GitHub
|
||||||
|
# Copyright © 2021 Aravinth Manivannan <realaravinth@batsense.net>
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as
|
||||||
|
# published by the Free Software Foundation, either version 3 of the
|
||||||
|
# License, or (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
readonly PROJECT_ROOT=$(pwd)
|
||||||
|
readonly TARBALL=zola.tar.gz
|
||||||
|
readonly SOURCE="https://github.com/getzola/zola/releases/download/v0.15.3/zola-v0.15.3-x86_64-unknown-linux-gnu.tar.gz"
|
||||||
|
|
||||||
|
readonly BIN_PATH=tmp/bin
|
||||||
|
readonly BIN=$BIN_PATH/zola
|
||||||
|
|
||||||
|
readonly DIST=public
|
||||||
|
|
||||||
|
source $(pwd)/scripts/lib.sh
|
||||||
|
|
||||||
|
help() {
|
||||||
|
cat << EOF
|
||||||
|
zola.sh: Zola build script
|
||||||
|
USAGE:
|
||||||
|
zola.sh <options>
|
||||||
|
OPTIONS:
|
||||||
|
b build build website
|
||||||
|
c clean clean dependencies and build artifacts
|
||||||
|
d deploy deploy build to branch
|
||||||
|
h help print this help menu
|
||||||
|
i install install build dependencies
|
||||||
|
u url make urls relative
|
||||||
|
z zola invoke zola
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
download() {
|
||||||
|
if [ ! -e $BIN_PATH ];
|
||||||
|
then
|
||||||
|
mkdir -p $BIN_PATH
|
||||||
|
cd $BIN_PATH
|
||||||
|
echo "[*] Downloading Zola"
|
||||||
|
wget --quiet --output-document=$TARBALL $SOURCE
|
||||||
|
tar -xvzf $TARBALL > /dev/null
|
||||||
|
rm $TARBALL
|
||||||
|
echo "[*] Downloaded zola into $BIN"
|
||||||
|
cd $PROJECT_ROOT
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
init() {
|
||||||
|
if [ ! -d $BIN_PATH ]
|
||||||
|
then
|
||||||
|
mkdir $BIN_PATH
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -f $BIN ]
|
||||||
|
then
|
||||||
|
cd $BIN_PATH
|
||||||
|
download
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
run() {
|
||||||
|
$BIN "${@:1}"
|
||||||
|
}
|
||||||
|
|
||||||
|
build() {
|
||||||
|
run build
|
||||||
|
}
|
||||||
|
|
||||||
|
no_absolute_url() {
|
||||||
|
sed -i 's/https:\/\/gna.org//g' $(find public -type f | grep html)
|
||||||
|
}
|
||||||
|
|
||||||
|
clean() {
|
||||||
|
rm -rf $BIN_PATH || true
|
||||||
|
rm -rf $DIST || true
|
||||||
|
echo "[*] Workspace cleaned"
|
||||||
|
}
|
||||||
|
|
||||||
|
# $1: branch name
|
||||||
|
# $2: directory containing build assets
|
||||||
|
# $3: Author in <author-name author@example.com> format
|
||||||
|
deploy() {
|
||||||
|
cd $PROJECT_ROOT
|
||||||
|
original_branch=$(git branch --show-current)
|
||||||
|
tmp_dir=$(mktemp -d)
|
||||||
|
cp -r $2/* $tmp_dir
|
||||||
|
|
||||||
|
if [[ -z $(git ls-remote --heads origin ${1}) ]]
|
||||||
|
then
|
||||||
|
echo "[*] Creating deployment branch $1"
|
||||||
|
git checkout --orphan $1
|
||||||
|
else
|
||||||
|
echo "[*] Deployment branch $1 exists, pulling changes from remote"
|
||||||
|
git fetch origin $1
|
||||||
|
git switch $1
|
||||||
|
fi
|
||||||
|
|
||||||
|
git rm -rf .
|
||||||
|
/bin/rm -rf *
|
||||||
|
cp -r $tmp_dir/* .
|
||||||
|
git add --all
|
||||||
|
if [ $(git status --porcelain | xargs | sed '/^$/d' | wc -l) -gt 0 ];
|
||||||
|
then
|
||||||
|
echo "[*] Repository has changed, committing changes"
|
||||||
|
git commit \
|
||||||
|
--author="$3" \
|
||||||
|
--message="new deploy: $(date --iso-8601=seconds)"
|
||||||
|
fi
|
||||||
|
git checkout $original_branch
|
||||||
|
}
|
||||||
|
|
||||||
|
check_arg $1
|
||||||
|
download
|
||||||
|
|
||||||
|
if match_arg $1 'i' 'install'
|
||||||
|
then
|
||||||
|
init
|
||||||
|
elif match_arg $1 'c' 'clean'
|
||||||
|
then
|
||||||
|
clean
|
||||||
|
elif match_arg $1 'd' 'deploy'
|
||||||
|
then
|
||||||
|
check_arg $2
|
||||||
|
check_arg $3
|
||||||
|
check_arg $4
|
||||||
|
deploy $2 $3 $4
|
||||||
|
elif match_arg $1 'b' 'build'
|
||||||
|
then
|
||||||
|
build
|
||||||
|
elif match_arg $1 'h' 'help'
|
||||||
|
then
|
||||||
|
help
|
||||||
|
elif match_arg $1 'u' 'url'
|
||||||
|
then
|
||||||
|
no_absolute_url
|
||||||
|
elif match_arg $1 'z' 'zola'
|
||||||
|
then
|
||||||
|
$BIN "${@:3}"
|
||||||
|
else
|
||||||
|
echo "Error: $1 is not an option"
|
||||||
|
help
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
exit 0
|
||||||
Loading…
Add table
Reference in a new issue