fastlane-plugin-flutter_version 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512186627d9a812af0d7e8429a7fece5da8eebb51980011a58aeb96489f49701
-  data.tar.gz: 544eb7cff0758a7e6691ceabe5f2fb83bb116916ef1867cd6b4106aac3e000bb
+  metadata.gz: 72062642dce0b537558b2a480a19a1c31c4cfd3c119a0278e12e2d25eae3c7d6
+  data.tar.gz: d5574a0cfe29e50524f3dc94c88aa3692bda2ea6988fe40d17f7306e52901666
 SHA512:
-  metadata.gz: 3a4a6a0469a305b0f865f56cfa58a00eaf096142910310f84d03bc03124d40f92206ce3f5f774386aa872326243e73e5cb7bbaab3e58947b8331f672273e7637
-  data.tar.gz: 4efc7f6d4e36f16b652c4966f882fae70021510e09ed7e724ad93a7f2a297898a82517cc8dca8923d574e846c3c221997fc68374ebdc38349857c4019df3f526
+  metadata.gz: a6947376adb60e834f72e92bd171c30de595eb5628844183b6a15968c0b4e1594477fc97ff8e2480a73a2e0f3b527326018ca2382c03cb72d947d1cece319294
+  data.tar.gz: f78067f666324d7022f3dc3adb7c844395571f9020b5ded531a4c50002616edcd6bafa824f61c043344b8b732a9ad9fac6fb872eaa48d45cf0685803fa7efe46

data/README.md

@@ -1,6 +1,6 @@
-# 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-2-orange.svg?style=flat-square)](#contributors-)
+[![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)
@@ -13,9 +13,23 @@ flutter_version is a Fastlane plugin to retrieve version code from Flutter proje
 
 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`:
 
-### From GitHub registry (Recommended)
+### From GitHub registry (recommended)
 
-Check out the instructions [here](https://github.com/tianhaoz95/fastlane-plugin-flutter_version/packages/143774).
+Install from the command line:
+
+```bash
+gem install fastlane-plugin-flutter_version --version "1.0.0" --source "https://rubygems.pkg.github.com/tianhaoz95"
+```
+
+Install via Gemfile:
+
+```bash
+source "https://rubygems.pkg.github.com/tianhaoz95" do
+  gem "fastlane-plugin-flutter_version", "1.0.0"
+end
+```
+
+Check out the instructions in [GitHub Registry](https://github.com/tianhaoz95/fastlane-plugin-flutter_version/packages/143774).
 
 ### From gem registry
 
@@ -27,11 +41,9 @@ Check out the instructions [here](https://rubygems.org/gems/fastlane-plugin-flut
 gem "fastlane-plugin-flutter_version", git: "https://github.com/tianhaoz95/fastlane-plugin-flutter-version"
 ```
 
-## About flutter_version
+## Usage
 
-A plugin to retrieve versioning information for Flutter projects.
-
-## Example
+### Android example
 
 The following example releases a Android app to Google Play Store without needing to manually specify the app version:
 
@@ -53,33 +65,34 @@ The line `flutter_version()` fetches the version information from the `pubspec.y
 
 For more details, check out the [example project configuration](https://github.com/tianhaoz95/photochat/blob/master/photochatapp/android/fastlane/Fastfile).
 
-## For developers
-
-### Install dependencies
-
-```bash
-bundle install
-```
+### iOS example
 
-If the command above complains about permission issue, use:
+The following example releases an iOS app to TestFlight without needing to manually specify the app version or build number:
 
-```bash
-sudo bundle install --path ./vendor/bundle
-```
-
-### Run tests for this plugin
-
-To run both the tests, and code style validation, run
-
-```bash
-bunlde exec rake
+```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
 ```
 
-To automatically fix many of the styling issues, use
+### Available options
 
-```bash
-bundle exec rake rubocop:auto_correct -a
-```
+| 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` |
 
 ## Issues and feedback
 
@@ -108,6 +121,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <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>
 

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

@@ -10,6 +10,7 @@ module Fastlane
     class FlutterVersionAction < Action
       def self.run(params)
         pubspec_location = params[:pubspec_location]
+        should_omit_version_code = params[:should_omit_version_code]
         begin
           pubspec = YAML.load_file(pubspec_location)
         # rubocop:disable Style/RescueStandardError
@@ -19,11 +20,19 @@ module Fastlane
         # rubocop:enable Style/RescueStandardError
         version = pubspec['version']
         UI.message('The full version is: '.dup.concat(version))
-        unless version.include?('+')
+        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: '.dup.concat(version_name))
@@ -65,6 +74,14 @@ module Fastlane
             optional: true,
             type: String,
             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

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

@@ -2,6 +2,6 @@
 
 module Fastlane
   module FlutterVersion
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-flutter_version
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - tianhaoz95
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler