Enhanced x735-Script: Packaging, Performance, and Automation

.github/workflows/bin/create-version.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -e
+
+readonly PACKAGE_PATH="$1"
+readonly CONTROL_PATH="$2"
+readonly PACKAGE_VERSION="$3"
+declare -a ARCH_LIST=("arm64" "armhf")
+
+# Create the "versions" directory if it doesn't exist
+mkdir -p ${PACKAGE_PATH}/versions
+
+for arch_type in "${ARCH_LIST[@]}"; do
+    # first change the Architecture in the DEBIAN/control file
+    sed -i "/^Architecture:.*/ c Architecture: ${arch_type}" "${CONTROL_PATH}"
+
+    # Run docker image and build the package in the mounted directory
+    docker run --rm -v "$PACKAGE_PATH":/pkg multiarch/debian-debootstrap:"${arch_type}"-bullseye \
+    dpkg-deb --build /pkg/x735-script-pkg "/pkg/versions/x735-script_${PACKAGE_VERSION}_${arch_type}.deb"
+done

.github/workflows/bin/create_release_note.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+set -e
+set -o pipefail
+
+readonly FILE_NOT_EXIST="152"
+readonly INVALID_CLI_ARG_COUNT="154"
+readonly INVALID_REQUEST="155"
+
+terminate() {
+    local -r msg=$1
+    local -r err_code=${2:-150}
+    echo "${msg}" >&2
+    exit "${err_code}"
+}
+
+if [[ $# -ne 5 ]]; then
+    terminate "Usage: $0 TEMPLATE_FILE GITHUB_REPO TOKEN RELEASE_ID CHANGELOG_MSG" "${INVALID_CLI_ARG_COUNT}"
+fi
+
+readonly TEMPLATE_FILE_PATH=$1
+readonly GITHUB_REPO=$2
+readonly TOKEN=$3
+readonly RELEASE_ID=$4
+readonly CHANGELOG_MSG=$5
+
+readonly release_url="https://api.github.com/repos/${GITHUB_REPO}/releases/${RELEASE_ID}"
+
+# Check if the artifact path exists
+if [ ! -s "$TEMPLATE_FILE_PATH" ]; then
+  terminate "Template release note not found or empty: ${TEMPLATE_FILE_PATH}" "${FILE_NOT_EXIST}"
+fi
+
+function convert_to_md_line_breaks() {
+    local input="$1"
+    local output=""
+    local IFS=$'\n'
+
+    for line in $input; do
+        output="${output}${line}\\n\\n"
+    done
+
+    echo "$output"
+}
+
+release_data=$(curl -L \
+  -H "Accept: application/vnd.github+json" \
+  -H "Authorization: Bearer ${TOKEN}" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  "${release_url}")
+
+## check if data are JSON and the response is correct
+if ! [[ "$release_data" =~ ^\{.*\}$ ]] || [[ ! $(echo "$release_data" | jq -e --arg RELEASE_ID "$RELEASE_ID" '.id == ($RELEASE_ID|tonumber)') ]]; then
+    terminate "The script was not able to pull release data." "${INVALID_REQUEST}"
+fi
+
+RELEASE_PUBLICH_DATE=$(echo "$release_data" | jq -r '.published_at')
+TAG_NAME=$(echo "$release_data" | jq -r '.tag_name' | sed -n 's/^v//p')
+
+readme_text=$(awk -v tag_name="${TAG_NAME}" -v release_date="$RELEASE_PUBLICH_DATE" -v repo="$GITHUB_REPO" -v msg="$CHANGELOG_MSG" '
+    {
+    gsub(/##TAG_NAME##/, tag_name);
+    gsub(/##RELEASE_DATE##/, release_date);
+    gsub(/##REPO##/, repo);
+    gsub(/##MSG##/, msg);
+    print;
+    }
+' "$TEMPLATE_FILE_PATH")
+
+release_text=$(convert_to_md_line_breaks "$readme_text")
+
+send_release_note=$(curl -L \
+  -X PATCH \
+  -H "Accept: application/vnd.github+json" \
+  -H "Authorization: Bearer ${TOKEN}" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  -w "%{http_code}" \
+  -o /dev/null \
+  "${release_url}" \
+  -d "{\"body\":\"${release_text}\"}")
+
+if [[ "$send_release_note" -ne "200" ]]; then
+    terminate "The script was not able to push release note." "${INVALID_REQUEST}"
+fi

.github/workflows/bin/update_changelog.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+set -e
+
+readonly CHANGELOG_PATH="$1"
+readonly CHANGELOG_MSG="$2"
+readonly VERSION="$3"
+
+readonly INVALID_CLI_ARG_COUNT="154"
+
+terminate() {
+    local -r msg=$1
+    local -r err_code=${2:-150}
+    echo "${msg}" >&2
+    exit "${err_code}"
+}
+
+# Check if commit message is not empty
+if [ ! -n "$CHANGELOG_MSG" ]; then
+    terminate "Error: No commit message found in the trigger commit." "${INVALID_CLI_ARG_COUNT}"
+fi
+
+# Function to check if DEBIAN/changelog file exists
+changelog_exists() {
+    [ -e "${CHANGELOG_PATH}" ]
+}
+
+# Function to create or append to DEBIAN/changelog
+create_or_append_changelog() {
+    local message=$1
+
+    if changelog_exists; then
+        dch --package x735-script --newversion "${VERSION}" --changelog "${CHANGELOG_PATH}" -- "$message [v${VERSION}]"
+    else
+        dch --package x735-script --newversion "${VERSION}" --create --changelog "${CHANGELOG_PATH}" -- "Initial Release. [v${VERSION}]"
+    fi
+}
+
+# Main script
+create_or_append_changelog "$CHANGELOG_MSG"

.github/workflows/bin/upload-artifacts.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+set -e
+
+readonly FILE_NOT_EXIST="152"
+readonly INVALID_CLI_ARG_COUNT="154"
+
+terminate() {
+    local -r msg=$1
+    local -r err_code=${2:-150}
+    echo "${msg}" >&2
+    exit "${err_code}"
+}
+
+# Function to upload an artifact to the release
+upload_artifact() {
+  local artifact_path=$1
+  local upload_url=$2
+  local token=$3
+
+  filename=$(basename "$artifact_path")
+  echo "Uploading $filename..."
+
+    curl -L \
+    -X POST \
+    -H "Accept: application/vnd.github+json" \
+    -H "Authorization: Bearer ${token}" \
+    -H "X-GitHub-Api-Version: 2022-11-28" \
+    -H "Content-Type: application/octet-stream" \
+    "$upload_url=$filename" \
+    --data-binary "@${artifact_path}"
+}
+
+# Main script starts here
+if [ $# -lt 3 ]; then
+  terminate "Usage: $0 <artifact_path> <upload_url> <token>" "${INVALID_CLI_ARG_COUNT}"
+fi
+
+artifact_path=$1
+upload_url=$2
+token=$3
+
+# Check if the artifact path exists
+if [ ! -f "$artifact_path" ]; then
+  terminate "Artifact file not found: ${artifact_path}" "${FILE_NOT_EXIST}"
+fi
+
+upload_artifact "$artifact_path" "$upload_url" "$token"

.github/workflows/build-package.yml

@@ -0,0 +1,127 @@
+name: Build and Package Fan Board Script
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+env:
+  WORKFLOW_PATH: ${GITHUB_WORKSPACE}/.github/workflows
+  PACKAGE_DEBIAN: ${GITHUB_WORKSPACE}/x735-script-pkg/DEBIAN
+  USER_NAME: ${{ vars.USER_NAME }}
+  USER_EMAIL: ${{ vars.USER_EMAIL }}
+
+jobs:
+  update_repo:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          token: ${{ secrets.CREATE_RELEASE_TOKEN }}
+
+      - name: Install Dependencies
+        run: |
+          # Install any necessary dependencies for modifing the repository
+          sudo apt update && sudo apt install -y devscripts
+
+      - name: Set up Environment
+        id: update_repo_settings
+        run: |
+          git config --local user.name "${{ env.USER_NAME }}"
+          git config --local user.email "${{ env.USER_EMAIL }}"
+
+          # changelog message gonna be in this case the last commit message where the tag is created.
+          echo "changelog_msg=$(git log -1 --pretty=%B | head -n 1)" >> "$GITHUB_OUTPUT"
+          echo "tag_name=$(echo "${GITHUB_REF}" | sed -n 's|^refs/tags/v||p')" >> "$GITHUB_OUTPUT"
+
+      - name: Update and Commit Changelog
+        run: |
+          export DEBFULLNAME="${{ env.USER_NAME }}"
+          export DEBEMAIL="${{ env.USER_EMAIL }}"
+          /bin/bash ${{ env.WORKFLOW_PATH }}/bin/update_changelog.sh "${{ env.PACKAGE_DEBIAN }}/changelog" "${{ steps.update_repo_settings.outputs.changelog_msg }}" "${{ steps.update_repo_settings.outputs.tag_name }}"
+
+      - name: Update Version
+        run: |
+          sed -i '/^Version:.*/ c Version: ${{ steps.update_repo_settings.outputs.tag_name }}' "${{ env.PACKAGE_DEBIAN }}/control"
+
+      - name: Commit Changelog Changes
+        id: commit_changelog
+        run: |
+          git add .
+          git commit -m "Update Changelog and Set Version to ${{ steps.update_repo_settings.outputs.tag_name }}"
+          #git remote set-url --push origin "https://${{ secrets.CREATE_RELEASE_TOKEN }}@github.com/${{ github.repository }}.git"
+          git push --follow-tags origin main
+
+          # Store the commit SHA as an output variable
+          echo "update_repo_sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
+
+    outputs:
+      tag_name: ${{ steps.update_repo_settings.outputs.tag_name }}
+      update_repo_sha: ${{ steps.commit_changelog.outputs.update_repo_sha }}
+      changelog_msg: ${{ steps.update_repo_settings.outputs.changelog_msg }}
+
+
+
+  build_and_package:
+    runs-on: ubuntu-latest
+    needs: update_repo
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.update_repo.outputs.update_repo_sha }}  # Use the update_repo_sha output from the previous job
+
+      - name: Install Dependencies
+        run: |
+          echo "Install any necessary dependencies for building your script here"
+          sudo apt update && sudo apt install -y dpkg qemu-user-static jq
+
+      - name: Set up QEMU for arm64
+        run: |
+          docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+
+      - name: Granting Permissions
+        run: |
+          # Grant execute permission to all files in DEBIAN directory, but the compat file
+          find ${{ env.PACKAGE_DEBIAN }} -type f ! -name 'compat' -exec chmod +x {} \;
+
+      - name: Build different ARCH Versions
+        run: |
+          # Run the create-version.sh script to build different versions
+          /bin/bash ${{ env.WORKFLOW_PATH }}/bin/create-version.sh "${GITHUB_WORKSPACE}" "${{ env.PACKAGE_DEBIAN }}/control" "${{ needs.update_repo.outputs.tag_name }}"
+
+      - name: Save Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: x735-script-artifacts
+          path: versions/x735-script_*.deb
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.CREATE_RELEASE_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release Version ${{ needs.update_repo.outputs.tag_name }}
+          draft: false
+          prerelease: false
+
+      - name: Upload Artifacts to Release and update Release Note
+        run: |
+          # Update Release Note
+          /bin/bash ${{ env.WORKFLOW_PATH }}/bin/create_release_note.sh \
+            "${{ env.WORKFLOW_PATH }}/templates/release_template.txt" \
+            "${{ github.repository }}" \
+            "${{ secrets.CREATE_RELEASE_TOKEN }}" \
+            "${{ steps.create_release.outputs.id }}" \
+            "${{ needs.update_repo.outputs.changelog_msg }}"
+
+          # Add a loop to upload each artifact
+          for artifact in ${GITHUB_WORKSPACE}/versions/x735-script_*.deb; do
+            /bin/bash ${{ env.WORKFLOW_PATH }}/bin/upload-artifacts.sh "$artifact" "${{ steps.create_release.outputs.upload_url }}" "${{ secrets.CREATE_RELEASE_TOKEN }}"
+          done