fastlane-plugin-git_build_versioning 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9c16c2044c0e12abaff29b3b374069d73d1df407fa4baeeb435d6397864c4d2
+  data.tar.gz: 5f1fe53e8ac1b46b4af3d17e7e90c561c7099f8cdaa46eee60bd8c86a143b5db
+SHA512:
+  metadata.gz: b03b79ff46121645b9dea7a543f99e55112f4702ce0fa30c3fea70fb05445c239bb348b07f605f77eef25022c66ae296ed6649e8feee5329e98822a69d8e6f20
+  data.tar.gz: 5fe421da8e09404d71726a3841f2f4b44a9d165e9837b5801b269aec0f9e80768bdc28bdb11e3b6aff174730d2d246a1f8a49ac31c7e137a53227b3baa0e4a78

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mikko Välimäki <mkko1373@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# git_build_versioning plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-git_build_versioning)
+
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-git_build_versioning`, add it to your project by running:
+
+```bash
+fastlane add_plugin git_build_versioning
+```
+
+## About git_build_versioning
+
+Use git for tagging build numbers for distributed sequential builds.
+
+This plugin will store build numbers as tags in the git repository. This makes it possible to create unique but reproducible builds in a distributed system. Storing build numbers in the git repository has several benefits over the traditional bump commits: each build is guaranteed to always have unique build number, the build numbers don't cause merge conflicts, it is very lightweight (when comparing to bump commits) and finally, it is highly visual as you can see your builds in the git history."
+
+## Example
+
+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`.
+
+```
+  build = reserve_git_build_number(
+    tag_prefix: 'build/'
+  )
+  
+  increment_build_number(
+    build_number: build
+  )
+  
+  # ...and continue with the release.
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## 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_
+
+_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).
+
+
+## TODO
+
+- Provide an example app
+- Make the plugin work with annotated tags
+- Add a custom hook to annotate tag (?)

data/lib/fastlane/plugin/git_build_versioning.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/git_build_versioning/version'
+
+module Fastlane
+  module GitBuildVersioning
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::GitBuildVersioning.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/git_build_versioning/actions/get_git_build_number_action.rb

@@ -0,0 +1,54 @@
+require 'fastlane/action'
+require_relative '../helper/git_build_versioning_helper'
+
+module Fastlane
+  module Actions
+    class GetGitBuildNumberAction < Action
+      def self.run(params)
+        tag_prefix = (params[:tag_prefix] || 'build/')
+        Helper::GitBuildVersioningHelper.current_build_number(tag_prefix)
+      end
+
+      def self.description
+        "Use git for tagging your builds for unique distributed sequential build numbers"
+      end
+
+      def self.output
+        [
+          ['GIT_BUILD_NUMBER', 'The build number from git']
+        ]
+      end
+
+      def self.authors
+        ["Mikko Välimäki"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        <<-DETAILS
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :tag_prefix,
+                                  env_name: "GIT_BUILD_VERSIONING_TAG_PREFIX",
+                               description: "A prefix to be used with tag names",
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb

@@ -0,0 +1,54 @@
+require 'fastlane/action'
+require_relative '../helper/git_build_versioning_helper'
+
+module Fastlane
+  module Actions
+    class ReserveGitBuildNumberAction < Action
+      def self.run(params)
+        tag_prefix = (params[:tag_prefix] || 'build/')
+        Helper::GitBuildVersioningHelper.reserve_build_number(tag_prefix)
+      end
+
+      def self.description
+        "Use git for tagging your builds for unique distributed sequential build numbers"
+      end
+
+      def self.output
+        [
+          ['GIT_BUILD_NUMBER', 'The build number from git']
+        ]
+      end
+
+      def self.authors
+        ["Mikko Välimäki"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        <<-DETAILS
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :tag_prefix,
+                                  env_name: "GIT_BUILD_VERSIONING_TAG_PREFIX",
+                               description: "A prefix to be used with tag names",
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/git_build_versioning/helper/git_build_versioning_helper.rb

@@ -0,0 +1,116 @@
+require 'fastlane_core/ui/ui'
+
+def number_or_nil(string)
+  num = string.to_i
+  num if num.to_s == string
+end
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class GitBuildTag
+      def initialize(str, tag_prefix)
+        # Instance variables
+        @tag_prefix = tag_prefix
+        @str = str
+      end
+
+      def hash
+        (@str.split('refs/tags/').first || '').strip
+      end
+
+      def build_number
+        full_name = @str.split('refs/tags/').last
+        m = full_name.match(/^#{@tag_prefix}(\d+)$/)
+        if m && m[1]
+          number_or_nil(m[1])
+        end
+      end
+
+      def is_build_number?
+        build_number != nil
+      end
+
+      def to_s
+        "GitBuildTag<#{self.hash}, #{self.build_number}>"
+      end
+    end
+
+    class GitBuildVersioningHelper
+      def self.is_git?
+        Actions.sh('git rev-parse HEAD', log: false)
+        return true
+      rescue
+        return false
+      end
+
+      # class methods that you define here become available in your action
+      # as `Helper::GitBuildVersioningHelper.your_method`
+      #
+      def self.reserve_build_number(tag_prefix)
+        head = self.head
+        tags = self.build_tags(tag_prefix)
+
+        current = tags
+                  .select { |t| t.hash == head }
+                  .map(&:build_number)
+                  .last
+
+        if current.nil?
+          latest = tags
+                   .map(&:build_number)
+                   .last
+          current = (latest || 0) + 1
+
+          tag_name = "#{tag_prefix}#{current}"
+          Actions.sh("git tag #{tag_name} && git push --quiet origin #{tag_name}", log: false)
+          UI.success("Tagging #{tag_name}")
+        else
+          UI.success("Current commit already tagged as build #{tag_name}")
+        end
+
+        current
+      end
+
+      def self.last_build_number(tag_prefix)
+        self.build_tags(tag_prefix)
+            .map(&:build_number)
+            .last
+      end
+
+      def self.current_build_number(tag_prefix)
+        head = self.head
+        tags = self.build_tags(tag_prefix)
+
+        tags.select { |t| t.hash == head }
+            .map(&:build_number)
+            .last
+      end
+
+      def self.head
+        if self.is_git?
+          head = Actions.sh("git rev-parse HEAD", log: false)
+          (head || "").strip
+        else
+          UI.user_error!("No git repository detected")
+        end
+      end
+
+      def self.build_tags(tag_prefix)
+        if self.is_git?
+
+          builds = Actions.sh("git ls-remote --tags --refs --quiet", log: false)
+          tags = builds.split(/\r?\n/)
+                       .map { |s| GitBuildTag.new(s, tag_prefix) }
+                       .reject { |t| t.build_number.nil? }
+                       .sort_by(&:build_number)
+
+          tags
+        else
+          UI.user_error!("No git repository detected")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module GitBuildVersioning
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-git_build_versioning
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikko Välimäki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.105.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.105.2
+description: 
+email: mkko1373@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/git_build_versioning.rb
+- lib/fastlane/plugin/git_build_versioning/actions/get_git_build_number_action.rb
+- lib/fastlane/plugin/git_build_versioning/actions/reserve_git_build_number_action.rb
+- lib/fastlane/plugin/git_build_versioning/helper/git_build_versioning_helper.rb
+- lib/fastlane/plugin/git_build_versioning/version.rb
+homepage: https://github.com/mkko/fastlane-plugin-git-build-number
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Store build numbers in git tags for distributed sequential builds
+test_files: []