mirror of
https://github.com/unraid/api.git
synced 2026-01-02 06:30:02 -06:00
4f5c367fdf
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced automated build and release processes with containerized builds, improved caching, and refined artifact handling. - Introduced new configuration options to strengthen versioning, integrity checks, and pull request tracking. - Added a new Dockerfile for building the Node.js application. - Added new environment variables for API versioning and validation control. - Implemented comprehensive management of PM2 processes and state. - Introduced a new GitHub Actions workflow for automating staging plugin deployment upon pull request closure. - Updated logic for handling plugin installation and error feedback. - Added new asynchronous methods for managing PM2 processes. - Updated logging configurations for better control over log outputs. - Added Prettier configuration for consistent code formatting. - Introduced a configuration to prevent the application from watching for file changes. - **Bug Fixes** - Improved error handling and user feedback during the installation of staging versions. - **Documentation** - Removed outdated introductory documentation to streamline project information. - **Chores** - Updated deployment routines and validation steps to improve release consistency and error handling. - Simplified packaging and build scripts for smoother staging and production workflows. - Excluded sensitive files from the Docker build context. - Updated the `.gitignore` file to prevent unnecessary files from being tracked. - Adjusted the test timeout configuration for improved test reliability. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
104 lines
4.2 KiB
Bash
Executable File
104 lines
4.2 KiB
Bash
Executable File
#!/bin/bash
|
|
# LEGACY SCRIPT - Kept for validation purposes. If still present after May 2025, delete.
|
|
# passes `shellcheck` and `shfmt -i 2`
|
|
|
|
[[ "$1" == "s" ]] && env=staging
|
|
[[ "$1" == "p" ]] && env=production
|
|
[[ -z "${env}" ]] && echo "usage: [s|p]" && exit 1
|
|
|
|
# If we have a second parameter, it's the PR number (for Pull request builds)
|
|
[[ -n "$2" ]] && PR="$2" || PR=""
|
|
|
|
DIR=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
|
|
MAINDIR=$(dirname "$(dirname "${DIR}")")
|
|
tmpdir=$(mktemp -d)
|
|
pluginSrc=$(basename "${DIR}")
|
|
plugin="${pluginSrc}"
|
|
version=$(date +"%Y.%m.%d.%H%M")
|
|
plgfile="${MAINDIR}/plugins/${plugin}.plg"
|
|
txzfile="${MAINDIR}/archive/${plugin}-${version}.txz"
|
|
|
|
# create txz package
|
|
mkdir -p "$(dirname "${txzfile}")"
|
|
mkdir -p "${tmpdir}"
|
|
# shellcheck disable=SC2046
|
|
cp --parents -f $(find . -type f ! \( -iname ".DS_Store" -o -iname "pkg_build.sh" -o -iname "makepkg" -o -iname "explodepkg" -o -iname "sftp-config.json" \)) "${tmpdir}/"
|
|
cd "${tmpdir}" || exit 1
|
|
|
|
chmod 0755 -R .
|
|
sudo chown root:root -R .
|
|
sudo "${MAINDIR}/source/dynamix.unraid.net/makepkg" -l y -c y "${txzfile}"
|
|
sudo rm -rf "${tmpdir}"
|
|
md5=$(md5sum "${txzfile}" | cut -f 1 -d ' ')
|
|
echo "MD5: ${md5}"
|
|
sha256=$(sha256sum "${txzfile}" | cut -f 1 -d ' ')
|
|
echo "SHA256: ${sha256}"
|
|
|
|
# test txz package
|
|
mkdir -p "${tmpdir}"
|
|
cd "${tmpdir}" || exit 1
|
|
RET=$(sudo "${MAINDIR}/source/dynamix.unraid.net/explodepkg" "${txzfile}" 2>&1 >/dev/null)
|
|
sudo rm -rf "${tmpdir}"
|
|
[[ "${RET}" != "" ]] && echo "Error: invalid txz package created: ${txzfile}" && exit 1
|
|
cd "${DIR}" || exit 1
|
|
|
|
# define vars for plg
|
|
PLUGIN_URL="https://stable.dl.unraid.net/unraid-api/\&name;.plg"
|
|
MAIN_TXZ="https://stable.dl.unraid.net/unraid-api/${plugin}-${version}.txz"
|
|
API_TGZ="https://stable.dl.unraid.net/unraid-api/unraid-api-${API_VERSION}.tgz"
|
|
# Check if PR is set, use a different path if so
|
|
if [[ -n "${PR}" ]]; then
|
|
MAIN_TXZ="https://preview.dl.unraid.net/unraid-api/pr/${PR}/${plugin}-${version}.txz"
|
|
API_TGZ="https://preview.dl.unraid.net/unraid-api/pr/${PR}/unraid-api-${API_VERSION}.tgz"
|
|
PLUGIN_URL="https://preview.dl.unraid.net/unraid-api/pr/${PR}/${plugin}.plg"
|
|
elif [[ "${env}" == "staging" ]]; then
|
|
PLUGIN_URL="https://preview.dl.unraid.net/unraid-api/\&name;.plg"
|
|
MAIN_TXZ="https://preview.dl.unraid.net/unraid-api/${plugin}-${version}.txz"
|
|
API_TGZ="https://preview.dl.unraid.net/unraid-api/unraid-api-${API_VERSION}.tgz"
|
|
fi
|
|
|
|
# update plg file
|
|
sed -i -E "s#(ENTITY name\s*)\".*\"#\1\"${plugin}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY env\s*)\".*\"#\1\"${env}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY version\s*)\".*\"#\1\"${version}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY pluginURL\s*)\".*\"#\1\"${PLUGIN_URL}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY SHA256\s*)\".*\"#\1\"${sha256}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY MAIN_TXZ\s*)\".*\"#\1\"${MAIN_TXZ}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY API_TGZ\s*)\".*\"#\1\"${API_TGZ}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY PR\s*)\".*\"#\1\"${PR}\"#g" "${plgfile}"
|
|
|
|
# set from environment vars
|
|
sed -i -E "s#(ENTITY API_version\s*)\".*\"#\1\"${API_VERSION}\"#g" "${plgfile}"
|
|
sed -i -E "s#(ENTITY API_SHA256\s*)\".*\"#\1\"${API_SHA256}\"#g" "${plgfile}"
|
|
|
|
# validate that all ENTITY values are present
|
|
required_entities=("name" "env" "version" "pluginURL" "SHA256" "MAIN_TXZ" "API_TGZ" "NODEJS_FILENAME" "NODEJS_SHA256" "NODEJS_TXZ" "API_version" "API_SHA256")
|
|
validation_failed=false
|
|
for entity in "${required_entities[@]}"; do
|
|
entity_value=$(grep -oP "ENTITY ${entity} \"\K[^\"]*" "${plgfile}" || echo "")
|
|
if [[ -z "${entity_value}" ]]; then
|
|
echo "Error: ENTITY ${entity} was not replaced correctly in ${plgfile}"
|
|
validation_failed=true
|
|
elif [[ "${entity_value}" =~ ^[[:space:]]*$ ]]; then
|
|
echo "Error: ENTITY ${entity} has an empty value in ${plgfile}"
|
|
validation_failed=true
|
|
fi
|
|
done
|
|
|
|
if [[ "${validation_failed}" == "true" ]]; then
|
|
if [[ -f "${plgfile}.bak" ]]; then
|
|
echo "Restoring backup due to validation failure"
|
|
mv "${plgfile}.bak" "${plgfile}"
|
|
fi
|
|
exit 1
|
|
fi
|
|
|
|
# add changelog for major versions
|
|
# sed -i "/<CHANGES>/a ###${version}\n" ${plgfile}
|
|
|
|
echo
|
|
grep -E "ENTITY (name|PLUGIN_URL|env|version|MD5|SHA256|node_api_version|MAIN_TXZ|API_TGZ)" "${plgfile}"
|
|
echo
|
|
echo "${env} plugin: ${plgfile}"
|
|
echo "${env} txz: ${txzfile}"
|