Merge pull request #3 from web-lifter/codex/implement-github-action-for-packaging-and-release

Add GitHub release workflow and update updater

Author: johnoconnor0

.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Build Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create zip
+        run: |
+          mkdir -p build
+          zip -r build/woocommerce-utils.zip . -x '*.git*' '*.github*' 'build*'
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: build/woocommerce-utils.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

includes/class-wc-utils-updater.php

@@ -9,18 +9,11 @@
 class WC_Utils_Updater {
 
     /**
-     * GitHub repository raw URL.
+     * GitHub repository slug (e.g. "owner/repo").
      *
      * @var string
      */
-    private $raw_url;
-
-    /**
-     * GitHub repository zip URL.
-     *
-     * @var string
-     */
-    private $zip_url;
+    private $repo;
 
     /**
      * Plugin file basename.
@@ -39,11 +32,10 @@ class WC_Utils_Updater {
     /**
      * Constructor.
      */
-    public function __construct( $repo_raw_url, $repo_zip_url, $plugin_basename, $version ) {
-        $this->raw_url        = trailingslashit( $repo_raw_url );
-        $this->zip_url        = $repo_zip_url;
+    public function __construct( $repo_slug, $plugin_basename, $version ) {
+        $this->repo            = $repo_slug;
         $this->plugin_basename = $plugin_basename;
-        $this->version        = $version;
+        $this->version         = $version;
 
         add_filter( 'pre_set_site_transient_update_plugins', array( $this, 'check_for_update' ) );
         add_filter( 'plugins_api', array( $this, 'plugins_api' ), 10, 3 );
@@ -60,7 +52,8 @@ public function check_for_update( $transient ) {
             return $transient;
         }
 
-        $remote = wp_remote_get( $this->raw_url . 'woocommerce-utils.php' );
+        $api_url = sprintf( 'https://api.github.com/repos/%s/releases/latest', $this->repo );
+        $remote  = wp_remote_get( $api_url, array( 'headers' => array( 'Accept' => 'application/vnd.github.v3+json' ) ) );
 
         if ( is_wp_error( $remote ) ) {
             return $transient;
@@ -70,13 +63,13 @@ public function check_for_update( $transient ) {
             return $transient;
         }
 
-        $body = wp_remote_retrieve_body( $remote );
-
-        if ( ! preg_match( '/^\s*\*\s*Version:\s*(.*)$/mi', $body, $matches ) ) {
+        $release = json_decode( wp_remote_retrieve_body( $remote ), true );
+        if ( empty( $release['tag_name'] ) || empty( $release['zipball_url'] ) ) {
             return $transient;
         }
 
-        $remote_version = trim( $matches[1] );
+        $remote_tag     = ltrim( $release['tag_name'], 'v' );
+        $remote_version = $remote_tag;
 
         if ( version_compare( $this->version, $remote_version, '>=' ) ) {
             return $transient;
@@ -85,8 +78,8 @@ public function check_for_update( $transient ) {
         $plugin             = new stdClass();
         $plugin->slug       = dirname( $this->plugin_basename );
         $plugin->new_version = $remote_version;
-        $plugin->url        = $this->raw_url;
-        $plugin->package    = $this->zip_url;
+        $plugin->url        = $release['html_url'];
+        $plugin->package    = $release['zipball_url'];
 
         $transient->response[ $this->plugin_basename ] = $plugin;
 
@@ -110,7 +103,22 @@ public function plugins_api( $result, $action, $args ) {
             return $result;
         }
 
-        $remote = wp_remote_get( $this->raw_url . 'readme.txt' );
+        $api_url = sprintf( 'https://api.github.com/repos/%s/releases/latest', $this->repo );
+        $release  = wp_remote_get( $api_url, array( 'headers' => array( 'Accept' => 'application/vnd.github.v3+json' ) ) );
+
+        if ( is_wp_error( $release ) || 200 !== wp_remote_retrieve_response_code( $release ) ) {
+            return $result;
+        }
+
+        $release_data = json_decode( wp_remote_retrieve_body( $release ), true );
+        if ( empty( $release_data['tag_name'] ) || empty( $release_data['zipball_url'] ) ) {
+            return $result;
+        }
+
+        $tag    = $release_data['tag_name'];
+        $zip    = $release_data['zipball_url'];
+
+        $remote  = wp_remote_get( sprintf( 'https://raw.githubusercontent.com/%s/%s/readme.txt', $this->repo, $tag ) );
 
         if ( is_wp_error( $remote ) || 200 !== wp_remote_retrieve_response_code( $remote ) ) {
             return $result;
@@ -121,11 +129,11 @@ public function plugins_api( $result, $action, $args ) {
         $info = new stdClass();
         $info->name    = 'WooCommerce Utils';
         $info->slug    = dirname( $this->plugin_basename );
-        $info->version = $this->version;
+        $info->version = ltrim( $tag, 'v' );
         $info->sections = array(
             'description' => $readme,
         );
-        $info->download_link = $this->zip_url;
+        $info->download_link = $zip;
 
         return $info;
     }

woocommerce-utils.php

@@ -23,11 +23,9 @@
 if ( ! defined( 'WC_UTILS_URL' ) ) {
     define( 'WC_UTILS_URL', plugin_dir_url( __FILE__ ) );
 }
-if ( ! defined( 'WC_UTILS_REPO_RAW' ) ) {
-    define( 'WC_UTILS_REPO_RAW', 'https://raw.githubusercontent.com/web-lifter/woocommerce-utils/main/' );
-}
-if ( ! defined( 'WC_UTILS_REPO_ZIP' ) ) {
-    define( 'WC_UTILS_REPO_ZIP', 'https://github.com/web-lifter/woocommerce-utils/archive/refs/heads/main.zip' );
+// GitHub repository slug used for updates.
+if ( ! defined( 'WC_UTILS_GITHUB_REPO' ) ) {
+    define( 'WC_UTILS_GITHUB_REPO', 'web-lifter/woocommerce-utils' );
 }
 
 /**
@@ -48,7 +46,7 @@ function wc_utils_init() {
     // Initialize classes.
     new WC_Utils_Admin();
     new WC_Utils_Features();
-    new WC_Utils_Updater( WC_UTILS_REPO_RAW, WC_UTILS_REPO_ZIP, plugin_basename( __FILE__ ), WC_UTILS_VERSION );
+    new WC_Utils_Updater( WC_UTILS_GITHUB_REPO, plugin_basename( __FILE__ ), WC_UTILS_VERSION );
 }
 add_action( 'plugins_loaded', 'wc_utils_init' );