Merge Cooker 0.8.1b into game downloader

.github/workflows/cooker-selfhosted.yml

@@ -1,32 +1,31 @@
 name: "Build cooker"
 
 on:
-  # push:
-  #   branches:
-  #    - cooker*
-  #    - feat*
-  #   paths:
-  #    - '.github/workflows/**'
-  #    - 'automation_tools/**'
-  #    - 'emu-configs/**'
-  #    - 'es-configs/**'
-  #    - 'functions/**'
-  #    - 'rd-submodules/**'
-  #    - '*.sh'
-  #    - 'net.retrodeck.retrodeck.yml'
-  #    - 'net.retrodeck.retrodeck.appdata.xml'
-  # pull_request: 
-  #   branches:
-  #    - cooker*
+  push:
+    branches:
+     - cooker*
+     - feat*
+    paths:
+     - '.github/workflows/**'
+     - 'automation_tools/**'
+     - 'emu-configs/**'
+     - 'es-configs/**'
+     - 'functions/**'
+     - 'rd-submodules/**'
+     - '*.sh'
+     - 'net.retrodeck.retrodeck.yml'
+     - 'net.retrodeck.retrodeck.appdata.xml'
+  pull_request: 
+    branches:
+     - cooker*
 
   # Italy (CET): 11:00 PM
   # Japan (JST): 7:00 AM
-  schedule:
-    - cron: '0 22 * * *'
+  # schedule:
+  #  - cron: '0 22 * * *'
 
   workflow_dispatch:
 
-
 jobs:
 
   Building_RetroDECK:
@@ -49,6 +48,33 @@ jobs:
       - name: Generate cooker build ID
         run: "/bin/bash ${GITHUB_WORKSPACE}/automation_tools/cooker_build_id.sh"
 
+      - name: Get branch name
+        id: branch_name
+        run: echo "BRANCH_NAME=$(echo $GITHUB_REF | sed 's|refs/heads/||')" >> $GITHUB_ENV
+
+      # if it's a feature branch it will not marked as "latest" cooker version
+      - name: "Set makeLatest (cooker only)"
+        run: |
+          if [[ "$BRANCH_NAME" == 'feat/'* || "$BRANCH_NAME" == 'refs/'* ]]; then
+            echo "MAKE_LATEST=false" >> $GITHUB_ENV
+          else
+            echo "MAKE_LATEST=true" >> $GITHUB_ENV
+          fi
+
+      # if the branch is coming from a PR the tag should be manually built
+      - name: "Generate version tag"
+        run: |
+          if [[ "$BRANCH_NAME" == 'refs/'* ]]; then
+            pr_number=$(echo ${{env.BRANCH_NAME}} | awk -F'/' '{print $3}')
+            source_branch=$(curl -s "https://api.github.com/repos/XargonWan/RetroDECK/pulls/$pr_number" | jq -r '.head.ref')
+            source_branch=${source_branch//\//-}
+            echo "[DEBUG] source branch is: $source_branch"
+            echo "TAG=PR-$pr_number-$source_branch-${{ env.buildid }}" >> $GITHUB_ENV
+          else
+            echo "TAG=${{env.BRANCH_NAME}}-${{ env.buildid }}" >> $GITHUB_ENV
+          fi
+          echo "Version TAG: ${{ env.TAG }}"
+
       # backing up manifest in case download fails and hashes must be recalculated
       - name: Manifest backup
         run: "cp ${GITHUB_WORKSPACE}/net.retrodeck.retrodeck.yml ${GITHUB_WORKSPACE}/net.retrodeck.retrodeck.yml.bak"
@@ -109,23 +135,10 @@ jobs:
         id: commits
         continue-on-error: true
 
-      - name: Get branch name
-        id: branch_name
-        run: echo "BRANCH_NAME=$(echo $GITHUB_REF | sed 's|refs/heads/||')" >> $GITHUB_ENV
-
-      # if it's a feature branch it will not marked as "latest" cooker version
-      - name: "Set makeLatest (cooker only)"
-        run: |
-          if [[ "$BRANCH_NAME" == 'feat/'* ]]; then
-            echo "MAKE_LATEST=false" >> $GITHUB_ENV
-          else
-            echo "MAKE_LATEST=true" >> $GITHUB_ENV
-          fi
-
       - name: Publish the flatpak in a new cooker release
         uses: ncipollo/release-action@v1
         with:
-          tag: "${{env.BRANCH_NAME}}-${{ env.buildid }}"
+          tag: "${{env.TAG}}"
           body: |
             # Release Notes (Cooker)
             This is a cooker snapshot based on the commit: ${{ github.event.repository.full_name }}@${{github.sha}}.
@@ -134,12 +147,12 @@ jobs:
             ## Commits since last release
             ${{ steps.commits.outputs.commits }}
 
-            For the full release note for this build please refer to the channel [#BETA-TESTING](https://discord.gg/qQcrFvaA2C) on our Discord server.
+            For the full release note for this build please refer to the channel [#BETA-TESTING](https://discord.gg/WDc5C9YWMx) on our Discord server.
 
             Cooker channel is provided for the community to test fixes and explore new functionality.
             Please DO NOT open issues or ask support on this build.
 
-          artifacts: "RetroDECK-cooker.flatpak,RetroDECK-Artifact.tar.gz"
+          artifacts: "RetroDECK-cooker.flatpak,RetroDECK-cooker.flatpak.sha,RetroDECK-Artifact.tar.gz"
           allowUpdates: true
           makeLatest: ${{env.MAKE_LATEST}} # if it's a feat branch is not considered the latest build
           token: ${{ secrets.TRIGGER_BUILD_TOKEN }}
@@ -154,3 +167,53 @@ jobs:
           path: RetroDECK-cooker.flatpak
         continue-on-error: true
 
+      # - name: Upload RetroDECK-cooker.flatpak to Gitea Release
+      #   run: |
+      #     # Set variables for Gitea host, organization, repository, access token, and release details
+      #     GITEA_HOST="repo.retrodeck.net"
+      #     ORGANIZATION="RetroDECK"
+      #     REPO="RetroDECK-cooker"
+      #     GITEA_TOKEN="${{ secrets.GITEA_TRIGGER_BUILD_TOKEN }}"
+      #     RELEASE_NAME="RetroDECK ${{env.TAG}}"
+      #     TAG="${{env.TAG}}"
+      #     RELEASE_BODY="# Release Notes (Cooker)
+      #     This is a cooker snapshot based on the commit: ${{ github.event.repository.full_name }}@${{github.sha}}.
+      #     On branch [${{env.BRANCH_NAME}}](https://repo.retrodeck.net/RetroDECK/RetroDECK/src/branch/${{env.BRANCH_NAME}}).
+
+      #     ## Commits since last release
+      #     ${{ steps.commits.outputs.commits }}
+
+      #     For the full release note for this build please refer to the channel [#BETA-TESTING](https://discord.gg/WDc5C9YWMx) on our Discord server.
+
+      #     Cooker channel is provided for the community to test fixes and explore new functionality.
+      #     Please DO NOT open issues or ask support on this build."
+
+      #     # Create a release using curl and capture the release ID
+      #     release_response=$(curl -X POST \
+      #         -H "Authorization: token ${GITEA_TOKEN}" \
+      #         -H "Content-Type: application/json" \
+      #         -d "{\"tag_name\":\"$TAG\",\"name\":\"$RELEASE_NAME\",\"body\":\"$RELEASE_BODY\"}" \
+      #         "http://$GITEA_HOST/api/v1/repos/$ORGANIZATION/$REPO/releases")
+
+      #     # Extract the release ID from the response
+      #     release_id=$(echo $release_response | jq -r '.id')
+
+      #     # Upload artifacts
+      #     curl -X POST \
+      #         -H "Authorization: token ${GITEA_TOKEN}" \
+      #         -H "Content-Type: multipart/form-data" \
+      #         -F "[email protected]" \
+      #         "http://$GITEA_HOST/api/v1/repos/$ORGANIZATION/$REPO/releases/$release_id/assets?name=RetroDECK-cooker.flatpak"
+
+      #     # Upload artifacts sha
+      #     curl -X POST \
+      #         -H "Authorization: token ${GITEA_TOKEN}" \
+      #         -H "Content-Type: multipart/form-data" \
+      #         -F "[email protected]" \
+      #         "http://$GITEA_HOST/api/v1/repos/$ORGANIZATION/$REPO/releases/$release_id/assets?name=RetroDECK-cooker.flatpak.sha"
+
+      #     curl -X POST \
+      #         -H "Authorization: token ${GITEA_TOKEN}" \
+      #         -H "Content-Type: multipart/form-data" \
+      #         -F "[email protected]" \
+      #         "http://$GITEA_HOST/api/v1/repos/$ORGANIZATION/$REPO/releases/$release_id/assets?name=RetroDECK-Artifact.tar.gz"

.github/workflows/main-selfhosted.yml

@@ -108,7 +108,7 @@ jobs:
           tag: ${{ env.REL_VER }}
           name: "RetroDECK v${{ env.REL_VER }}"
           bodyFile: "body.md"
-          artifacts: "RetroDECK.flatpak,RetroDECK-Artifact.tar.gz"
+          artifacts: "RetroDECK.flatpak,RetroDECK.flatpak.sha,RetroDECK-Artifact.tar.gz"
           allowUpdates: true
           makeLatest: true
           token: ${{ secrets.TRIGGER_BUILD_TOKEN }}
@@ -122,3 +122,36 @@ jobs:
           name: retrodeck-flatpak
           path: RetroDECK.flatpak
         continue-on-error: true
+
+      - name: Publish the flatpak in a new release on Gitea
+        uses: ncipollo/release-action@v1
+        env:
+          REL_VER: ${{ env.REL_VER }}
+        with:
+          tag: ${{ env.REL_VER }}
+          name: "RetroDECK v${{ env.REL_VER }}"
+          bodyFile: "body.md"
+          artifacts: "RetroDECK.flatpak,RetroDECK-Artifact.tar.gz"
+          allowUpdates: true
+          makeLatest: true
+          token: ${{ secrets.GITEA_TRIGGER_BUILD_TOKEN }}
+          repo: "https://repo.retrodeck.net/RetroDECK/RetroDECK"
+        continue-on-error: true
+
+      - name: Upload RetroDECK.flatpak to Gitea Release
+        run: |
+          curl -X POST \
+            -H "Authorization: token ${GITEA_TOKEN}" \
+            -F "[email protected]" \
+            "https://repo.retrodeck.net/RetroDECK/RetroDECK/releases/${{ env.REL_VER }}/assets?name=RetroDECK.flatpak"
+        env:
+          GITEA_TOKEN: ${{ secrets.GITEA_TRIGGER_BUILD_TOKEN }}
+
+      - name: Upload RetroDECK.flatpak.sha to Gitea Release
+        run: |
+          curl -X POST \
+            -H "Authorization: token ${GITEA_TOKEN}" \
+            -F "[email protected]" \
+            "https://repo.retrodeck.net/RetroDECK/RetroDECK/releases/${{ env.REL_VER }}/assets?name=RetroDECK.flatpak.sha"
+        env:
+          GITEA_TOKEN: ${{ secrets.GITEA_TRIGGER_BUILD_TOKEN }}

.gitignore

@@ -21,6 +21,7 @@ rd-submodules/es-de/patches-tmp*
 .local/
 buildid
 *.bak
+incconfigs/
 
 # Python #
 ##########

README.md

@@ -46,15 +46,15 @@ For more information read up here:
 RetroDECK is a [EmulationStation Desktop Edition](https://es-de.org) (ES-DE) powered Linux [Flatpak application](https://flathub.org/apps/net.retrodeck.retrodeck) that thanks to its `RetroDECK Framework` it builds-in and manage a variety of emulators and other software that allows you to play your favorite retro (and even not-so-retro) games in one complete package.
 
 ### So what does that mean?
-It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK configures them for you and put them into one application you can download from Flathub.
+It means that RetroDECK provides all the emulators, systems and a frontend. RetroDECK configures them for you and puts them into one application you can download from Flathub.
 
 By being one application RetroDECK can put all important files in one location for all the emulators, instead of having them spread out over your entire system and even add features on top to orchestrate them seamlessly.
 
 
 ### The RetroDECK Framework
-As previously mentioned, RetroDECK also adds the `RetroDECK Framework` on top of the emulators and ES-DE interface that allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set per emulator basis to create a uniformity between them.
+As previously mentioned, RetroDECK also adds the `RetroDECK Framework` on top of the emulators and ES-DE interface which allows deeper integrations between emulators and easier exposure to a variety of features that you otherwise need to set on a per emulator basis to create a uniformity between them.
 
-The `RetroDECK Configurator` is a `Utility` that some parts of exposes the `RetroDECK Framework` to the RetroDECK users.
+The `RetroDECK Configurator` is a `Utility` that exposes some parts of the `RetroDECK Framework` to the RetroDECK users.
 
 **What can the RetroDECK Framework and by extent the RetroDECK Configurator do?**
 
@@ -67,18 +67,18 @@ It can help with:
 - Auto installing some free BIOSes
 - Install prebuilt Steam Input profiles for devices like the Steam Deck and external controllers
 - Easier management of `mods`, `roms`, `texture_packs`, `scraped media`, `screenshots`, `saves / states` `gamelists` and more
-- Give access to global presets that can be acitivated to configure things over many emulators in one go like: `RetroAchievements`
+- Give access to global presets that can be activated to configure things over many emulators in one go like: `RetroAchievements`
   `Borders` `Widescreen Mode` `Swaping A/B X/Y for Nintendo Games`
 
 For our long term vision you can check out the following wiki page:
 [RetroDECK: Visions and Goals](https://retrodeck.readthedocs.io/en/latest/wiki_about/visions-and-goals/)
 
 ### How to get support? 
-Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g) `🤝-community-support` and `🆘-support`.
+Use the supports channels on [Discord](https://discord.gg/WDc5C9YWMx) `🤝-community-support` and `🆘-support`.
 ### The RetroDECK community:
 [Website](https://retrodeck.net) <br/>
 [Wiki](https://github.com/XargonWan/RetroDECK/wiki) <br/>
-[Discord](https://discord.gg/Dz3szYsP8g)<br/>
+[Discord](https://discord.gg/WDc5C9YWMx)<br/>
 [Lemmy](https://lemmy.zip/c/retrodeck)<br/>
 [Subreddit](https://www.reddit.com/r/retrodeck)
 
@@ -99,6 +99,7 @@ Read up here on how to help out, there is something for everyone:
 | [RetroDECK](https://github.com/XargonWan/RetroDECK)          | This one, our main repo where the core of the project is  |
 | [RetroDECK-cooker](https://github.com/XargonWan/RetroDECK-cooker)  | Where we publish our test build, no code is hosted here |
 | [RetroDECK-Wiki](https://github.com/XargonWan/RetroDECK-Wiki)  | Where our wiki source code is |
+| [RetroDECK-website](https://github.com/XargonWan/RetroDECK-website)  | Where our website source code is |
 | [RetroDECK on Flathub](https://github.com/flathub/net.retrodeck.retrodeck) | Our little space in Flathub's organization                 |
 | [RetroDECK-MAME](https://github.com/XargonWan/RetroDECK-MAME)   | MAME is big to build, so it's pre-built here and then imported in the build |
 | [RetroDECK-ES-DE](https://github.com/XargonWan/RetroDECK-ES-DE)  | This is where we store our patched fork of ES-DE          |
@@ -109,7 +110,7 @@ Read up here on how to help out, there is something for everyone:
 Please check out the [Wiki](https://github.com/XargonWan/RetroDECK/wiki) for even more information.
 
 ## The FAQ
-The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and awnsers. 
+The RetroDECK [FAQ](https://github.com/XargonWan/RetroDECK/wiki/FAQs%3A-Frequently-asked-questions) on the wiki has a vast variety of questions and answers. 
 
 # How to get support? 
-Use the supports channels on [Discord](https://discord.gg/Dz3szYsP8g). 
+Use the supports channels on [Discord](https://discord.gg/WDc5C9YWMx). 

automation_tools/appdata_management.sh

@@ -7,24 +7,24 @@ source automation_tools/version_extractor.sh
 
 # Fetch appdata version
 appdata_version=$(fetch_appdata_version)
-echo -e "Appdata:\t\t$appdata_version"
+log i "Appdata:\t\t$appdata_version"
 
 # Defining manifest file location
 appdata_file="net.retrodeck.retrodeck.appdata.xml"
 
 # Check if release with appdata_version already exists
 if grep -q "version=\"$appdata_version\"" "$appdata_file"; then
-    echo "Deleting existing release version $appdata_version..."
+    log i "Deleting existing release version $appdata_version..."
 
     # Remove the existing release entry
     sed -i "/<release version=\"$appdata_version\"/,/<\/release>/d" "$appdata_file"
 fi
 
-echo "Adding new release version $appdata_version..."
+log i "Adding new release version $appdata_version..."
 
 # Get today's date in the required format (YYYY-MM-DD)
 today_date=$(date +"%Y-%m-%d")
-echo "Today is $today_date"
+log i "Today is $today_date"
 
 # Construct the release snippet
 release_snippet="\

automation_tools/flatpak_build_bundle.sh

@@ -4,6 +4,8 @@
 
 if [ "${GITHUB_REF##*/}" = "main" ]; then
     flatpak build-bundle "${GITHUB_WORKSPACE}/.local" "$GITHUB_WORKSPACE/RetroDECK.flatpak" net.retrodeck.retrodeck
+    sha256sum RetroDECK.flatpak > RetroDECK.flatpak.sha
 else
     flatpak build-bundle "${GITHUB_WORKSPACE}/.local" "$GITHUB_WORKSPACE/RetroDECK-cooker.flatpak" net.retrodeck.retrodeck
+    sha256sum RetroDECK-cooker.flatpak > RetroDECK-cooker.flatpak.sha
 fi

automation_tools/install_dependencies.sh

@@ -1,6 +1,31 @@
 #!/bin/bash
-# This scritp is installing the required dependencies to correctly run the pipeline and buold the flatpak
+# This script is installing the required dependencies to correctly run the pipeline and build the flatpak
+
+unset pkg_mgr
+
+# rpm-ostree must be checked before dnf because a dnf (wrapper) command also works on rpm-ostree distros (not what we want)
+for potential_pkg_mgr in apt pacman rpm-ostree dnf; do
+  command -v "$potential_pkg_mgr" &> /dev/null && pkg_mgr="$potential_pkg_mgr" && break
+done
+
+case "$pkg_mgr" in
+  apt)
+    sudo apt install -y flatpak flatpak-builder p7zip-full xmlstarlet bzip2 curl jq
+    ;;
+  pacman)
+    sudo pacman -S --noconfirm flatpak flatpak-builder p7zip xmlstarlet bzip2
+    ;;
+  rpm-ostree)
+    echo "When using a distro with rpm-ostree, you shouldn't build directly on the host. Try using a distrobox."
+    exit 1
+    ;;
+  dnf)
+    sudo dnf install -y flatpak flatpak-builder p7zip p7zip-plugins xmlstarlet bzip2 curl
+    ;;
+  *)
+    echo "Package manager $pkg_mgr not supported. Please open an issue."
+    ;;
+esac
 
-sudo apt install -y flatpak flatpak-builder p7zip-full xmlstarlet bzip2 curl jq
 flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
-flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
+flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo

build-locally.sh → developer_toolbox/build_retrodeck_locally.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 
-# TODO: FEDORA
-# sudo dnf install -y flatpak flatpak-builder p7zip p7zip-plugins xmlstarlet bzip2 curl
+# WARNING: run this script from the project root folder, not from here!!
+
+git submodule update --init --recursive
 
 export GITHUB_WORKSPACE="."
 cp net.retrodeck.retrodeck.appdata.xml net.retrodeck.retrodeck.appdata.xml.bak