mirror/webgui
1
0
Fork 0
mirror of https://github.com/unraid/webgui.git synced 2026-05-12 07:10:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: refine PR plugin script and workflow for improved tarball handling

Browse Source 
- Updated `generate-pr-plugin.sh` to clarify usage instructions and rename parameters for local and remote tarball handling.
- Enhanced the GitHub Actions workflow to define local and remote tarball filenames, ensuring consistent naming and preventing SHA conflicts.
- Adjusted the script to use the correct tarball names during SHA256 calculation and plugin file generation, improving accuracy and reliability.
This commit is contained in:
Eli Bosley
2025-09-10 12:51:03 -04:00
parent 2c9c70e7eb
commit 95228bf8d6
2 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/scripts/generate-pr-plugin.sh
+15 -13
View File
@@ -3,17 +3,18 @@ set -euo pipefail
IFS=$'\n\t'
# Generate PR plugin file for Unraid
# Usage: ./generate-pr-plugin.sh <version> <pr_number> <commit_sha> <tarball_name> <txz_url> [plugin_url]
# Usage: ./generate-pr-plugin.sh <version> <pr_number> <commit_sha> <local_tarball> <remote_tarball> <txz_url> [plugin_url]
VERSION=$1
PR_NUMBER=$2
COMMIT_SHA=$3
TARBALL_NAME=$4
TXZ_URL=$5
PLUGIN_URL=${6:-""} # Optional plugin URL for updates
LOCAL_TARBALL=$4 # Local file for SHA calculation
REMOTE_TARBALL=$5 # Remote filename for download
TXZ_URL=$6
PLUGIN_URL=${7:-""} # Optional plugin URL for updates
if [ -z "$VERSION" ] || [ -z "$PR_NUMBER" ] || [ -z "$COMMIT_SHA" ] || [ -z "$TARBALL_NAME" ] || [ -z "$TXZ_URL" ]; then
echo "Usage: $0 <version> <pr_number> <commit_sha> <tarball_name> <txz_url> [plugin_url]"
if [ -z "$VERSION" ] || [ -z "$PR_NUMBER" ] || [ -z "$COMMIT_SHA" ] || [ -z "$LOCAL_TARBALL" ] || [ -z "$REMOTE_TARBALL" ] || [ -z "$TXZ_URL" ]; then
echo "Usage: $0 <version> <pr_number> <commit_sha> <local_tarball> <remote_tarball> <txz_url> [plugin_url]"
exit 1
fi
@@ -25,7 +26,7 @@ fi
# Use consistent filename (no version in filename, version is inside the plugin)
PLUGIN_NAME="webgui-pr-${PR_NUMBER}.plg"
TARBALL_SHA256=$(sha256sum "$TARBALL_NAME" | awk '{print $1}')
TARBALL_SHA256=$(sha256sum "$LOCAL_TARBALL" | awk '{print $1}')
echo "Generating plugin: $PLUGIN_NAME"
echo "Tarball SHA256: $TARBALL_SHA256"
@@ -37,10 +38,11 @@ cat > "$PLUGIN_NAME" << 'EOF'
<!ENTITY version "VERSION_PLACEHOLDER">
<!ENTITY author "unraid">
<!ENTITY pluginURL "PLUGIN_URL_PLACEHOLDER">
<!ENTITY tarball "TARBALL_PLACEHOLDER">
<!ENTITY tarball "REMOTE_TARBALL_PLACEHOLDER">
<!ENTITY sha256 "SHA256_PLACEHOLDER">
<!ENTITY pr "PR_PLACEHOLDER">
<!ENTITY commit "COMMIT_PLACEHOLDER">
<!ENTITY github "https://github.com/unraid/webgui">
]>
<PLUGIN name="&name;-&version;"
@@ -49,7 +51,7 @@ cat > "$PLUGIN_NAME" << 'EOF'
pluginURL="&pluginURL;"
min="6.12.0"
icon="wrench"
support="&pluginURL;/pull/&pr;">
support="&github;/pull/&pr;">
<CHANGES>
##&version;
@@ -80,7 +82,7 @@ echo "Created plugin directories"
</FILE>
<!-- Download tarball from GitHub -->
<FILE Name="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/TARBALL_PLACEHOLDER">
<FILE Name="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/REMOTE_TARBALL_PLACEHOLDER">
<URL>TXZ_URL_PLACEHOLDER</URL>
<SHA256>&sha256;</SHA256>
</FILE>
@@ -90,7 +92,7 @@ echo "Created plugin directories"
<INLINE>
<![CDATA[
BACKUP_DIR="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/backups"
TARBALL="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/TARBALL_PLACEHOLDER"
TARBALL="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/REMOTE_TARBALL_PLACEHOLDER"
MANIFEST="/boot/config/plugins/webgui-pr-PR_PLACEHOLDER/installed_files.txt"
echo "Starting file deployment..."
@@ -305,7 +307,7 @@ EOF
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS requires backup extension with -i
sed -i '' "s/VERSION_PLACEHOLDER/${VERSION}/g" "$PLUGIN_NAME"
sed -i '' "s/TARBALL_PLACEHOLDER/${TARBALL_NAME}/g" "$PLUGIN_NAME"
sed -i '' "s/REMOTE_TARBALL_PLACEHOLDER/${REMOTE_TARBALL}/g" "$PLUGIN_NAME"
sed -i '' "s/SHA256_PLACEHOLDER/${TARBALL_SHA256}/g" "$PLUGIN_NAME"
sed -i '' "s/PR_PLACEHOLDER/${PR_NUMBER}/g" "$PLUGIN_NAME"
sed -i '' "s/COMMIT_PLACEHOLDER/${COMMIT_SHA}/g" "$PLUGIN_NAME"
@@ -314,7 +316,7 @@ if [[ "$OSTYPE" == "darwin"* ]]; then
else
# Linux sed
sed -i "s/VERSION_PLACEHOLDER/${VERSION}/g" "$PLUGIN_NAME"
sed -i "s/TARBALL_PLACEHOLDER/${TARBALL_NAME}/g" "$PLUGIN_NAME"
sed -i "s/REMOTE_TARBALL_PLACEHOLDER/${REMOTE_TARBALL}/g" "$PLUGIN_NAME"
sed -i "s/SHA256_PLACEHOLDER/${TARBALL_SHA256}/g" "$PLUGIN_NAME"
sed -i "s/PR_PLACEHOLDER/${PR_NUMBER}/g" "$PLUGIN_NAME"
sed -i "s/COMMIT_PLACEHOLDER/${COMMIT_SHA}/g" "$PLUGIN_NAME"
.github/workflows/pr-plugin-build.yml
+21 -10
View File
@@ -51,14 +51,23 @@ jobs:
# Generate URLs with versioned TXZ to prevent SHA conflicts
S3_BASE_URL="${{ secrets.CLOUDFLARE_PREVIEW_BUCKET_BASE_URL }}/pr-plugins/pr-${{ github.event.pull_request.number }}"
# Define filenames
LOCAL_TXZ_NAME="webgui-pr-${{ github.event.pull_request.number }}.tar.gz"
REMOTE_TXZ_NAME="webgui-pr-${{ github.event.pull_request.number }}-${VERSION}.tar.gz"
PLUGIN_NAME="webgui-pr-${{ github.event.pull_request.number }}.plg"
# TXZ gets unique versioned path to prevent SHA conflicts on updates
TXZ_URL="${S3_BASE_URL}/webgui-pr-${{ github.event.pull_request.number }}-${VERSION}.tar.gz"
PLUGIN_URL="${S3_BASE_URL}/webgui-pr-${{ github.event.pull_request.number }}.plg"
TXZ_KEY="pr-plugins/pr-${{ github.event.pull_request.number }}/webgui-pr-${{ github.event.pull_request.number }}-${VERSION}.tar.gz"
PLUGIN_KEY="pr-plugins/pr-${{ github.event.pull_request.number }}/webgui-pr-${{ github.event.pull_request.number }}.plg"
TXZ_URL="${S3_BASE_URL}/${REMOTE_TXZ_NAME}"
PLUGIN_URL="${S3_BASE_URL}/${PLUGIN_NAME}"
TXZ_KEY="pr-plugins/pr-${{ github.event.pull_request.number }}/${REMOTE_TXZ_NAME}"
PLUGIN_KEY="pr-plugins/pr-${{ github.event.pull_request.number }}/${PLUGIN_NAME}"
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "pr_version=$PR_VERSION" >> $GITHUB_OUTPUT
echo "local_txz=$LOCAL_TXZ_NAME" >> $GITHUB_OUTPUT
echo "remote_txz=$REMOTE_TXZ_NAME" >> $GITHUB_OUTPUT
echo "plugin_name=$PLUGIN_NAME" >> $GITHUB_OUTPUT
echo "txz_url=$TXZ_URL" >> $GITHUB_OUTPUT
echo "plugin_url=$PLUGIN_URL" >> $GITHUB_OUTPUT
echo "txz_key=$TXZ_KEY" >> $GITHUB_OUTPUT
@@ -86,7 +95,7 @@ jobs:
cd build
echo "Creating tarball with contents:"
find usr/ -type f
tar -czf ../webgui-pr-${{ github.event.pull_request.number }}.tar.gz usr/
tar -czf ../${{ steps.version.outputs.local_txz }} usr/
cd ..
# Generate file list for plugin
@@ -96,7 +105,7 @@ jobs:
# Verify tarball contents
echo "Tarball contents:"
tar -tzf webgui-pr-${{ github.event.pull_request.number }}.tar.gz
tar -tzf ${{ steps.version.outputs.local_txz }}
- name: Configure AWS CLI for R2
if: steps.changed-files.outputs.has_changes == 'true'
@@ -110,7 +119,7 @@ jobs:
id: upload-txz
run: |
# Upload to R2 with versioned filename to prevent SHA conflicts
aws s3 cp "webgui-pr-${{ github.event.pull_request.number }}.tar.gz" \
aws s3 cp "${{ steps.version.outputs.local_txz }}" \
"s3://${{ secrets.CLOUDFLARE_PREVIEW_BUCKET_NAME }}/${{ steps.version.outputs.txz_key }}" \
--endpoint-url "${{ secrets.CLOUDFLARE_S3_URL }}" \
--acl public-read
@@ -120,12 +129,14 @@ jobs:
- name: Generate plugin file with R2 URL
if: steps.changed-files.outputs.has_changes == 'true'
run: |
# Pass versioned filename to match the URL
# Local file is non-versioned, but remote URL is versioned
# Pass local filename for SHA calculation and remote filename for download
bash .github/scripts/generate-pr-plugin.sh \
"${{ steps.version.outputs.version }}" \
"${{ github.event.pull_request.number }}" \
"$(git rev-parse --short HEAD)" \
"webgui-pr-${{ github.event.pull_request.number }}-${{ steps.version.outputs.version }}.tar.gz" \
"${{ steps.version.outputs.local_txz }}" \
"${{ steps.version.outputs.remote_txz }}" \
"${{ steps.version.outputs.txz_url }}" \
"${{ steps.version.outputs.plugin_url }}"
@@ -134,7 +145,7 @@ jobs:
id: upload-plg
run: |
# Upload PLG - overwrite existing for updates (consistent filename)
aws s3 cp "webgui-pr-${{ github.event.pull_request.number }}.plg" \
aws s3 cp "${{ steps.version.outputs.plugin_name }}" \
"s3://${{ secrets.CLOUDFLARE_PREVIEW_BUCKET_NAME }}/${{ steps.version.outputs.plugin_key }}" \
--endpoint-url "${{ secrets.CLOUDFLARE_S3_URL }}" \
--acl public-read