Merge pull request #36 from maliavko/dev

CI improvements, general bugfix

Author: maliavko

.github/workflows/build-library.yml

@@ -27,6 +27,12 @@ on:
         required: false
         default: false
         type: boolean
+      build_num:
+        required: true
+        type: string
+      version_tag:
+        required: true
+        type: string
 
 jobs:
   build-spotifar:
@@ -104,7 +110,7 @@ jobs:
         env:
           VCPKG_FEATURE_FLAGS: "binarycaching" # Possibly redundant, but explicitly sets the binary caching feature flag
           VCPKG_BINARY_SOURCES: "clear;files,${{ steps.vcpkg-cache.outputs.path }},readwrite"
-        run: cmake --preset ${{ matrix.platform }} -DBUILD_LIBRESPOT=${{inputs.build_librespot}} -DCMAKE_INSTALL_PREFIX=/install/${{ matrix.platform }} -DTESTING=${{ inputs.testing }}
+        run: cmake --preset ${{ matrix.platform }} -DPLUGIN_VER_BUILD=${{ inputs.build_num }} -DBUILD_LIBRESPOT=${{ inputs.build_librespot }} -DCMAKE_INSTALL_PREFIX=/install/${{ matrix.platform }} -DTESTING=${{ inputs.testing }}
 
       - name: Build spotifar
         run: cmake --build --preset ${{ matrix.platform }}-${{ inputs.build_type }} --target install --parallel $(nproc)
@@ -123,16 +129,17 @@ jobs:
           path: /install/${{ matrix.platform }}
 
       - name: Pack spotifar
+        if: inputs.upload_artifacts
         run: |
-          powershell Compress-Archive -Path /install/${{ matrix.platform }}/* -DestinationPath /install/spotifar-${{ matrix.platform }}.zip
+          powershell Compress-Archive -Path /install/${{ matrix.platform }}/* -DestinationPath /install/spotifar-${{ matrix.platform }}-${{ inputs.version_tag }}.zip
 
       - name: Packaging artifacts
         if: inputs.upload_artifacts
         uses: actions/upload-artifact@v4
         with:
           name: spotifar-${{ matrix.platform }}
-          path: /install/spotifar-${{ matrix.platform }}.zip
-      
+          path: /install/spotifar-${{ matrix.platform }}-${{ inputs.version_tag }}.zip
+
       # reporting
       - name: ccache statistics
         if: inputs.caching

.github/workflows/package-releases.yml

@@ -5,6 +5,41 @@ on:
     branches: [main]
 
 jobs:
+  get_version:
+    runs-on: windows-latest
+    outputs:
+      build_num: ${{ steps.version.outputs.build_num }}
+      tag: ${{ steps.version.outputs.tag }}
+
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+        
+      - name: Get version and label
+        id: version
+        run: |
+          $version = (Select-String -Path CMakeLists.txt -Pattern 'project\(.*VERSION ([0-9\.]+)').Matches[0].Groups[1].Value
+          $tag = git tag --sort=-taggerdate | Select-Object -Last 1
+          if (-not $tag) { $build_num = 0 }
+          else { $build_num = [int]($tag.Split('.')[-1]) }
+          $next_build_num = $build_num + 1
+          $full_version = "$version.$next_build_num"
+          $new_tag_name = "v$full_version"
+
+          Write-Host "Latest tag: $tag"
+          Write-Host "Build num: $build_num"
+          Write-Host "Next build num: $next_build_num"
+          Write-Host "Full version: $full_version"
+          Write-Host "New tag: $new_tag_name"
+
+          echo "tag=$new_tag_name" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+          echo "build_num=$next_build_num" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+
   build-librespot:
     uses: ./.github/workflows/build-librespot.yml
     permissions:
@@ -16,7 +51,7 @@ jobs:
     secrets: inherit
 
   build-spotifar:
-    needs: build-librespot
+    needs: [get_version, build-librespot]
     uses: ./.github/workflows/build-library.yml
     permissions:
       actions: read
@@ -26,37 +61,17 @@ jobs:
       build_librespot: false
       testing: false
       caching: false # no caching used for master releases
+      build_num: ${{ needs.get_version.outputs.build_num }}
+      version_tag: ${{ needs.get_version.outputs.tag }}
     secrets: inherit
 
   packaging:
-    needs: [build-librespot, build-spotifar]
+    needs: [get_version, build-librespot, build-spotifar]
     runs-on: windows-latest
     permissions:
       actions: read
       contents: write
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          fetch-tags: true
-
-      - name: Get version and label
-        id: get_version
-        run: |
-          $version = (Select-String -Path CMakeLists.txt -Pattern 'project\(.*VERSION ([0-9\.]+)').Matches[0].Groups[1].Value
-          $tag = git tag --sort=-taggerdate
-          Write-Host "Tag: $tag"
-          if (-not $tag) { $build_num = 0 }
-          else { $build_num = [int]($tag.Split('.')[-1]) }
-          Write-Host "Build num: $build_num"
-          $next_build_num = $build_num + 1
-          Write-Host "Next build num: $next_build_num"
-          $full_version = "$version.$next_build_num"
-          Write-Host "Full version: $full_version"
-          $new_tag_name = "v$full_version"
-          Write-Host "Tag: $new_tag_name"
-          echo "tag=$new_tag_name" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
-      
       - name: Download all artifacts
         uses: actions/download-artifact@v5
         with:
@@ -66,7 +81,7 @@ jobs:
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ steps.get_version.outputs.tag }}
-          name: Spotifar ${{ steps.get_version.outputs.tag }}
+          tag_name: ${{ needs.get_version.outputs.tag }}
+          name: Spotifar ${{ needs.get_version.outputs.tag }}
           files: artifacts/**/*
           generate_release_notes: true

.github/workflows/quick-build-and-test.yml

@@ -16,4 +16,6 @@ jobs:
       testing: true
       caching: true
       upload_artifacts: false
+      build_num: '0'  # not needed for testing
+      version_tag: ''  # not needed for testing
     secrets: inherit

CMakeLists.txt

@@ -7,6 +7,9 @@ set(PLUGIN_FILENAME "${PROJECT_NAME}.dll")
 set(PLUGIN_DESC "A front-end client for listening to music from Spotify")
 set(PLUGIN_AUTHOR "IgorM")
 set(PLUGIN_VER_STAGE VS_RC)
+if(NOT DEFINED PLUGIN_VER_BUILD)
+  set(PLUGIN_VER_BUILD "0")
+endif()
 # enum VERSION_STAGE
 # {
 #   VS_RELEASE      = 0,

src/hotkeys_handler.hpp

@@ -21,18 +21,18 @@ class hotkeys_handler:
     void volume_down(int step);
     void seek_forward(int step);
     void seek_backward(int step);
+    
+    /// @brief In case there is no active device and Librespot is not active
+    /// for any reason, this method provides a fallback solution to offer
+    /// for user to pick up manually a device to tranfer playback to from the list
+    /// of available
+    void pick_up_any();
 
     void tick();
 protected:
     /// @brief Returns a currently active device or nullptr
     auto get_active_device() const -> const spotify::device_t*;
 
-    /// @brief In case there is no active device and Librespot is not active
-    /// for any reason, this method provides a fallback solution to offer
-    /// for user to pick up manually a device to tranfer playback to from the list
-    /// of available
-    void pick_up_any();
-    
     // config handlers
     void on_global_hotkeys_setting_changed(bool is_enabled) override;
     void on_global_hotkey_changed(config::settings::hotkeys_t changed_keys) override;

src/plugin.cpp

@@ -157,6 +157,10 @@ void plugin::launch_librespot_process(const string &access_token)
     if (!librespot->is_running())
     {
         ui::hide_waiting();
+
+        // if the Librespot device is not running for whatever reason we are trying to pick up
+        // any device, including the offer for user to pick from the list
+        hotkeys->pick_up_any();
     }
     else
     {

src/version.hpp.in

@@ -10,6 +10,8 @@
 #define PLUGIN_NAME L"@PLUGIN_NAME@"
 #define PLUGIN_FILENAME L"@PLUGIN_FILENAME@"
 #define PLUGIN_AUTHOR L"@PLUGIN_AUTHOR@"
-#define PLUGIN_VERSION MAKEFARVERSION(@spotifar_VERSION_MAJOR@,@spotifar_VERSION_MINOR@,@spotifar_VERSION_PATCH@,0,(VERSION_STAGE)@PLUGIN_VER_STAGE@)
+// for some reason in far UI the version is shown in the mixed way: major.minor.build.revision, I swapped these components
+// here so the version in Far UI matches the one on Github
+#define PLUGIN_VERSION MAKEFARVERSION(@spotifar_VERSION_MAJOR@,@spotifar_VERSION_MINOR@,@PLUGIN_VER_BUILD@,@spotifar_VERSION_PATCH@,(VERSION_STAGE)@PLUGIN_VER_STAGE@)
 
 #endif // VERSION_HPP_190BAC0F_2C12_4955_932E_7A1D19EBC744