flutter_version_toolkit 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736f60244eeed999e2d85c932048d88e9b007f6299faefe99ef862c99a05a24d
-  data.tar.gz: 9945a963f23120bf40693a25c07b854ffdc813812c139d9367f153acab50e840
+  metadata.gz: 39266d57796319599936c017800611fbd64d03d638087841ea0d46f4a726d973
+  data.tar.gz: 2f17edee7182ce8ae94e4fb971c84d52b2e97651963879611fe28f444d19300c
 SHA512:
-  metadata.gz: 56691cddfb5e553b43a4ecb1bd148eee1842505ee33aa152a51c2be51bb002259d6bb740ceb1678cf820973294812e1f7eedaf755da312e72fd9e5b0abc635c2
-  data.tar.gz: 444e07fd32ea3042bba137a72ad7cff5cd1dd654a302ca5521ba5cf7081b4f9df882dc52061d0ea971846b2ce5620758a2c84d1514893158171701b3f9248e62
+  metadata.gz: dd8df34081850aa3a56f6d9d0e27f499cb5c5e1107d109a1d4313e874e4e9b4159ca500fd948b05d554fef30027c26b3dad0c032a3ece8ab06d6ffe9d31efc1b
+  data.tar.gz: bfe8446db2458e9e8d8c762adbd554a66c89098759fae1fd13c5365cfee4debfdfa83535255e3949ec7211f9259d74fce37a540d318de38898b9c5a08c72c85b

data/README.md

@@ -10,11 +10,74 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin flutter_version_toolkit
 ```
 
+## Description
+
+This Fastlane plugin extracts version information from your Flutter project's pubspec.yaml file. It uses an action (defined in flutter_version_toolkit_action.rb) to read the version name and build number, enabling you to integrate version control seamlessly into your deployment process.
+
 ## About flutter_version_toolkit
 
-A tool that help get version name and number from pubspec.yaml file in a flutter project
+A Fastlane plugin that helps extract version information from your Flutter project's pubspec.yaml file. It provides actions to read the version name and build number, making it easier to integrate version control into your deployment process.
+
+## Usage
+
+In your Fastfile, invoke the plugin as follows:
+
+The plugin offers the following actions:
+
+### get_flutter_version_name
+
+Retrieves the version name from your pubspec.yaml file.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+```ruby
+version_name = get_flutter_version_name(
+  pubspec_path: "./pubspec.yaml" # Optional, defaults to project root
+)
+puts "Version name: #{version_name}"
+```
+
+### get_flutter_version_code
+
+Retrieves the version code (build number) from your pubspec.yaml file.
+
+```ruby
+version_code = get_flutter_version_code(
+  pubspec_path: "./pubspec.yaml" # Optional, defaults to project root
+)
+puts "Version code: #{version_code}"
+```
+
+## Example Fastfile
+
+An example Fastfile to use the plugin in an Android deployment lane:
+
+```ruby
+default_platform(:android)
+
+platform :android do
+  desc "Deploy Android app to Play Store"
+  lane :deploy do
+    # Retrieve version information from Flutter's pubspec.yaml
+    version_name = get_flutter_version_name
+    version_code = get_flutter_version_code
+    
+    # Use these versions in your build configuration
+    gradle(
+      task: 'assemble',
+      build_type: 'Release',
+      properties: {
+        "versionName" => version_name,
+        "versionCode" => version_code
+      }
+    )
+    
+    upload_to_play_store(
+      track: 'internal',
+      version_name: version_name,
+      version_code: version_code
+    )
+  end
+end
+```
 
 ## Example
 

data/lib/fastlane/plugin/flutter_version_toolkit/actions/flutter_version_toolkit_action.rb

@@ -5,7 +5,10 @@ module Fastlane
   module Actions
     class FlutterVersionToolkitAction < Action
       def self.run(params)
-        UI.message("The flutter_version_toolkit plugin is working!")
+        version_info = Fastlane::FlutterVersionToolkit.read_version_from_pubspec
+        UI.user_error!("Could not retrieve version info from pubspec.yaml") if version_info.nil?
+        UI.message("Version Info: #{version_info.version_name} (build #{version_info.build_number})")
+        return version_info
       end
 
       def self.description
@@ -17,21 +20,24 @@ module Fastlane
       end
 
       def self.return_value
-        # If your method provides a return value, you can describe here what it does
+        "Returns a VersionInfo object with version name and build number, "
       end
 
       def self.details
         # Optional:
-        ".."
+        "Hello world"
       end
 
       def self.available_options
         [
-          # FastlaneCore::ConfigItem.new(key: :your_option,
-          #                         env_name: "FLUTTER_VERSION_TOOLKIT_YOUR_OPTION",
-          #                      description: "A description of your option",
-          #                         optional: false,
-          #                             type: String)
+          FastlaneCore::ConfigItem.new(
+            key: :pubspec_location,
+            env_name: 'PUBSPEC_LOCATION',
+            description: 'The location of pubspec.yml',
+            optional: true,
+            type: String,
+            default_value: '../pubspec.yaml'
+          ),
         ]
       end
 

data/lib/fastlane/plugin/flutter_version_toolkit/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module FlutterVersionToolkit
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flutter_version_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sanni Prasad