fastlane-plugin-flutter_version 0.1.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3aa6cd147116a2aa4849864bfcdb12443d211211349baa52bd1a71f2ed3084
-  data.tar.gz: d7c0f4ce4f0b14d44d63261cd49d8acf91974bb1091ebc70029ff264cd5255ec
+  metadata.gz: 72062642dce0b537558b2a480a19a1c31c4cfd3c119a0278e12e2d25eae3c7d6
+  data.tar.gz: d5574a0cfe29e50524f3dc94c88aa3692bda2ea6988fe40d17f7306e52901666
 SHA512:
-  metadata.gz: 642d42d5398dfcc79650db78968853c658f27bde1849bba6c1a3c319c3a0691d972535889ae8a4182f247fada6f2385bfad6c5c99d11bb2f3d757fa0280aee20
-  data.tar.gz: 11cde6e8201ff1b1c25826cfb6a2c2292767fd2677b15185dcc543d8168837c983845b0cd39a129c62625d724e793dab17958ea99c7276a54de9d615d0e8c6e4
+  metadata.gz: a6947376adb60e834f72e92bd171c30de595eb5628844183b6a15968c0b4e1594477fc97ff8e2480a73a2e0f3b527326018ca2382c03cb72d947d1cece319294
+  data.tar.gz: f78067f666324d7022f3dc3adb7c844395571f9020b5ded531a4c50002616edcd6bafa824f61c043344b8b732a9ad9fac6fb872eaa48d45cf0685803fa7efe46

data/README.md

@@ -1,50 +1,133 @@
-# flutter_version plugin
+# flutter_version (Fastlane plugin)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-flutter_version)
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/tianhaoz95/fastlane-plugin-flutter_version) 
+[![codecov](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version/branch/master/graph/badge.svg)](https://codecov.io/gh/tianhaoz95/fastlane-plugin-flutter_version)
 
-## Getting Started
+flutter_version is a Fastlane plugin to retrieve version code from Flutter projects which can be used to release changlogs and other metadata to marketplaces.
+
+## Installation
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-flutter_version`, add it to your project by adding the following lines in `Gemfile`:
 
-```Gemfile
-gem "fastlane-plugin-flutter_version", git: "https://github.com/tianhaoz95/fastlane-plugin-flutter-version"
+### From GitHub registry (recommended)
+
+Install from the command line:
+
+```bash
+gem install fastlane-plugin-flutter_version --version "1.0.0" --source "https://rubygems.pkg.github.com/tianhaoz95"
 ```
 
-## About flutter_version
+Install via Gemfile:
 
-A plugin to retrieve versioning information for Flutter projects.
+```bash
+source "https://rubygems.pkg.github.com/tianhaoz95" do
+  gem "fastlane-plugin-flutter_version", "1.0.0"
+end
+```
 
-## Example
+Check out the instructions in [GitHub Registry](https://github.com/tianhaoz95/fastlane-plugin-flutter_version/packages/143774).
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+### From gem registry
 
-## Run tests for this plugin
+Check out the instructions [here](https://rubygems.org/gems/fastlane-plugin-flutter_version).
 
-To run both the tests, and code style validation, run
+### Directly from Github
 
+```Gemfile
+gem "fastlane-plugin-flutter_version", git: "https://github.com/tianhaoz95/fastlane-plugin-flutter-version"
 ```
-rake
-```
 
-To automatically fix many of the styling issues, use
+## Usage
+
+### Android example
 
+The following example releases a Android app to Google Play Store without needing to manually specify the app version:
+
+```ruby
+desc "submit to internal track in Google Play Store"
+lane :internal do
+  gradle(task: 'bundle', build_type: 'Release')
+  upload_to_play_store(
+    track: 'internal',
+    version_code: flutter_version()["version_code"],
+    aab: '../build/app/outputs/bundle/release/app-release.aab',
+    skip_upload_screenshots: true,
+    skip_upload_images: true
+  )
+end
 ```
-rubocop -a
+
+The line `flutter_version()` fetches the version information from the `pubspec.yaml` file from the Flutter project and parses the version information from the file. This is convenient for continuous integration because it saves the effort for developers to keep track of version information in multiple places.
+
+For more details, check out the [example project configuration](https://github.com/tianhaoz95/photochat/blob/master/photochatapp/android/fastlane/Fastfile).
+
+### iOS example
+
+The following example releases an iOS app to TestFlight without needing to manually specify the app version or build number:
+
+```ruby
+desc "submit to TestFlight"
+lane :internal do
+  # https://docs.fastlane.tools/actions/increment_version_number/
+  increment_version_number(
+    xcodeproj: "Runner.xcodeproj",
+    version_number: flutter_version()["version_name"] # Set a specific version number
+  )
+    # https://docs.fastlane.tools/actions/increment_build_number/
+  increment_build_number(
+    xcodeproj: "Runner.xcodeproj",
+    build_number: flutter_version()["version_code"] # Set a specific build number
+  )
+  build_app(workspace: "Runner.xcworkspace", export_method: "app-store")
+  upload_to_testflight
+end
 ```
 
-## Issues and Feedback
+### Available options
+
+| Name | Description | Optional | Type | Default |
+|:---:|:---:|:---:|:---:|:---:|
+| `pubspec_location` | The location of the `pubspec.yaml` file. | :white_check_mark: | `String` | `../pubspec.yaml` |
+| `should_omit_version_code` | If the version code should be omitted for projects that do not use a version code. | :white_check_mark: | `Boolean` | `false` |
 
-For any other issues and feedback about this plugin, please submit it to this repository.
+## Issues and feedback
+
+For any other issues and feedback about this plugin, please submit it to [this repository](https://github.com/tianhaoz95/fastlane-plugin-flutter_version).
 
 ## Troubleshooting
 
 If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
 
-## Using _fastlane_ Plugins
+## Using Fastlane plugins
 
 For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
 
-## About _fastlane_
+## About Fastlane
+
+Fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://www.shunkakinoki.com/"><img src="https://avatars0.githubusercontent.com/u/39187513?v=4" width="100px;" alt=""/><br /><sub><b>Shun Kakinoki</b></sub></a><br /><a href="https://github.com/tianhaoz95/fastlane-plugin-flutter_version/commits?author=shunkakinoki" title="Code">💻</a></td>
+    <td align="center"><a href="http://tianhaoz.com"><img src="https://avatars3.githubusercontent.com/u/16887772?v=4" width="100px;" alt=""/><br /><sub><b>Tianhao Zhou</b></sub></a><br /><a href="https://github.com/tianhaoz95/fastlane-plugin-flutter_version/commits?author=tianhaoz95" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/davidbrenner"><img src="https://avatars3.githubusercontent.com/u/236870?v=4" width="100px;" alt=""/><br /><sub><b>davidbrenner</b></sub></a><br /><a href="#ideas-davidbrenner" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/tianhaoz95/fastlane-plugin-flutter_version/commits?author=davidbrenner" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://lahaus.com"><img src="https://avatars2.githubusercontent.com/u/76348?v=4" width="100px;" alt=""/><br /><sub><b>Daniel Gomez</b></sub></a><br /><a href="#ideas-danielgomezrico" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
-_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/fastlane/plugin/flutter_version.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'fastlane/plugin/flutter_version/version'
 
 module Fastlane
+  # The plugin wrapper
   module FlutterVersion
     # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes

data/lib/fastlane/plugin/flutter_version/actions/flutter_version_action.rb

@@ -1,61 +1,96 @@
+# frozen_string_literal: true
+
 require 'fastlane/action'
 require 'yaml'
 require_relative '../helper/flutter_version_helper'
 
 module Fastlane
   module Actions
+    # The top-level plugin interface
     class FlutterVersionAction < Action
       def self.run(params)
-        UI.message("The flutter_version plugin is working!")
         pubspec_location = params[:pubspec_location]
-        pubspec = YAML.load_file(pubspec_location)
-        version = pubspec["version"]
-        UI.message("The full version is: ".concat(version))
-        if not version.include? "+"
-          raise "Verson code indicator (+) not foud in pubspec.yml"
+        should_omit_version_code = params[:should_omit_version_code]
+        begin
+          pubspec = YAML.load_file(pubspec_location)
+        # rubocop:disable Style/RescueStandardError
+        rescue
+          raise 'Read pubspec.yaml failed'
+        end
+        # rubocop:enable Style/RescueStandardError
+        version = pubspec['version']
+        UI.message('The full version is: '.dup.concat(version))
+        has_version_code_pattern = version.include?('+')
+        if should_omit_version_code && has_version_code_pattern
+          raise 'Version code omitted but verson code indicator (+) found in pubspec.yml'
+        end
+        if !should_omit_version_code && !has_version_code_pattern
+          raise 'Verson code indicator (+) not found in pubspec.yml'
         end
-        version_sections = version.split("+")
+
+        version_sections = if should_omit_version_code
+                             [version, 'NOT_FOUND']
+                           else
+                             version.split('+')
+                           end
         version_name = version_sections[0]
         version_code = version_sections[1]
-        UI.message("The version name: ".concat(version_name))
-        UI.message("The version code: ".concat(version_code))
-        return version_code
+        UI.message('The version name: '.dup.concat(version_name))
+        UI.message('The version code: '.dup.concat(version_code))
+        {
+          'version_code' => version_code,
+          'version_name' => version_name
+        }
       end
 
       def self.description
-        "A plugin to retrieve versioning information for Flutter projects."
+        'A plugin to retrieve versioning information for Flutter projects.'
       end
 
       def self.authors
-        ["tianhaoz95"]
+        ['tianhaoz95']
       end
 
       def self.return_value
         [
-          ['VERSION_CODE', 'The version code']
+          ['VERSION_CODE', 'The version code'],
+          ['VERSION_NAME', 'The verison name']
         ]
       end
 
       def self.details
-        "The plugin reads and parses pubspec.yml of a Flutter project and composes the versioning information into structured data to be consumed by various releasing automations."
+        "The plugin reads and parses pubspec.yml of a Flutter
+        project and composes the versioning information into
+        structured data to be consumed by various releasing
+        automations."
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
             key: :pubspec_location,
-            env_name: "PUBSPEC_LOCATION",
-            description: "The location of pubspec.yml",
+            env_name: 'PUBSPEC_LOCATION',
+            description: 'The location of pubspec.yml',
             optional: true,
             type: String,
-            default_value:"../pubspec.yaml"
+            default_value: '../pubspec.yaml'
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :should_omit_version_code,
+            env_name: 'SHOULD_OMIT_VERSION_CODE',
+            description: 'If the version code should be omitted for projects that do not use a version code',
+            optional: true,
+            type: Boolean,
+            default_value: false
+          )
         ]
       end
 
-      def self.is_supported?(platform)
+      # rubocop:disable Naming/PredicateName
+      def self.is_supported?(_platform)
         true
       end
+      # rubocop:enable Naming/PredicateName
     end
   end
 end

data/lib/fastlane/plugin/flutter_version/helper/flutter_version_helper.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'fastlane_core/ui/ui'
 
+# Fastlane namespace
 module Fastlane
-  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+  UI = FastlaneCore::UI unless Fastlane.const_defined?('UI')
 
   module Helper
+    # Generated helper function for the plugin
     class FlutterVersionHelper
       # class methods that you define here become available in your action
       # as `Helper::FlutterVersionHelper.your_method`
-      #
       def self.show_message
-        UI.message("Hello from the flutter_version plugin helper!")
+        UI.message('Hello from the flutter_version plugin helper!')
       end
     end
   end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Fastlane
   module FlutterVersion
-    VERSION = "0.1.4"
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-flutter_version
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.1
 platform: ruby
 authors:
 - tianhaoz95
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fastlane
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.142.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.142.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-require_tools
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fastlane
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.142.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.142.0
+        version: '0'
 description: 
 email: tianhaoz@umich.edu
 executables: []
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="