fastlane-plugin-semantic_release 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e7240446d4e3e3b57e47c9f13f5c9dca2dd3e79784a534eda9768e786fd92c
-  data.tar.gz: 7012750d1542fe5e56a7182ac23d6c1561321ce5a4a3ef6f3b17868b048ec85f
+  metadata.gz: a0d36b85b2320a1df53dbf3763dfc1bc4fa9bdfad599f032ff2d5ea320c65328
+  data.tar.gz: 61e35082c7b62e22873b42ba21c9c16d3d3041c167357d9c2bcf3b679bd3bb6f
 SHA512:
-  metadata.gz: b3b9a597a9a58ddb9b8e7ba8523d68f1d650d1b628c7652bdded8015f620360ecc949b97a4f584c20ef691cd5a0e4decd8aeddbccedc6385bff62350ef23de68
-  data.tar.gz: 846eef67764067475d0be534d0343eddb5e310aac348aa240acace95871ec169ee021cf9ac635a5b50995b3b01e519e40568e09f9956a74f261dd9177bc09f2e
+  metadata.gz: 6b1c95f31840c0f65634472136d73e398317d9bc64edbaee5caefce6e4e6308edf15a8f78873c13384ff2d59b7ab7b48bf2786f279c81d2e8b708a3c35ace88b
+  data.tar.gz: c917d1ff56ddec4295823857a832c5c9f736049d60437e48ed5a4daa39bce5dba63e26007cffae0c9c1f2f6da8998430a24520af374aeb414a2c9b41f7967f35

data/README.md

@@ -1,6 +1,6 @@
-# semantic_release plugin
+# semantic_release plugin for `fastlane`
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-semantic_release)
+[![CircleCI](https://circleci.com/gh/xotahal/fastlane-plugin-semantic_release.svg?style=svg)](https://circleci.com/gh/xotahal/fastlane-plugin-semantic_release) [![License](https://img.shields.io/github/license/SiarheiFedartsou/fastlane-plugin-versioning.svg)](https://github.com/SiarheiFedartsou/fastlane-plugin-versioning/blob/master/LICENSE) [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-semantic_release.svg)](https://badge.fury.io/rb/fastlane-plugin-semantic_release) [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-versioning)
 
 ## Getting Started
 
@@ -14,25 +14,42 @@ fastlane add_plugin semantic_release
 
 Automated version managment and generator of release notes.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+Inspired by [semantic-release](https://github.com/semantic-release/semantic-release) for npm packages. Based on [conventional commits](https://www.conventionalcommits.org/).
 
-## 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`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+## Actions
 
-## Run tests for this plugin
-
-To run both the tests, and code style validation, run
+### analyze_commits
+- analyzes your git history
+- finds last tag on current branch (for example ios/beta/1.3.2)
+- parses the last version from tag (1.3.2)
+- gets all commits since this tag
+- analyzes subject of every single commit and increases version number if there is a need (check conventional commit rules)
+- if next version number is higher then last version number it will recommend you to release this version
 
+Please run `fastlane action analyze_commits` to see all documentation in your command line.
+```
+isReleasable = analyze_commits(match: 'ios/beta*')
+```
+It leave these variables in lane_context. You can get them by `lane_context[SharedValues::RELEASE_NEXT_VERSION]` - for example.
 ```
-rake
+['RELEASE_ANALYZED', 'True if commits were analyzed.'],
+['RELEASE_IS_NEXT_VERSION_HIGHER', 'True if next version is higher then last version'],
+['RELEASE_LAST_TAG_HASH', 'Hash of commit that is tagged as a last version'],
+['RELEASE_LAST_VERSION', 'Last version number - parsed from last tag.'],
+['RELEASE_NEXT_MAJOR_VERSION', 'Major number of the next version'],
+['RELEASE_NEXT_MINOR_VERSION', 'Minor number of the next version'],
+['RELEASE_NEXT_PATCH_VERSION', 'Patch number of the next version'],
+['RELEASE_NEXT_VERSION', 'Next version string in format (major.minor.patch)'],
 ```
+### conventional_changelog
+- parses all commits since last version
+- group those commits by their type (fix, feat, docs, refactor, chore, etc)
+- and creates formated release notes either in markdown or in slack format
 
-To automatically fix many of the styling issues, use
 ```
-rubocop -a
+notes = conventional_changelog(format: 'slack', title: 'Android Alpha')
 ```
 
 ## Issues and Feedback
@@ -50,3 +67,11 @@ For more information about how the `fastlane` plugin system works, check out the
 ## 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).
+
+## Questions
+
+If you need anything ping us on [twitter](http://bit.ly/t-xotahal).
+
+| Jiri Otahal                                                                                                                                |
+| ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [<img src="https://avatars3.githubusercontent.com/u/3531955?v=4" width="100px;" style="border-radius:50px"/>](http://bit.ly/t-xotahal) |

data/lib/fastlane/plugin/semantic_release/actions/analyze_commits.rb

@@ -14,7 +14,6 @@ module Fastlane
       RELEASE_NEXT_VERSION = :RELEASE_NEXT_VERSION
     end
 
-
     class AnalyzeCommitsAction < Action
       def self.run(params)
         # Last version tag name
@@ -26,81 +25,81 @@ module Fastlane
         version = '0.0.0'
 
         begin
-          #Try to find the tag
+          # Try to find the tag
           command = "git describe --tags --match=#{params[:match]}"
           tag = Actions.sh(command, log: false)
         rescue
           UI.message("Tag was not found for match pattern - #{params[:match]}")
         end
 
-        if tag.empty? then
+        if tag.empty?
           UI.message("First commit of the branch is taken as a begining of next release")
           # If there is no tag found we taking the first commit of current branch
           hash = Actions.sh('git rev-list --max-parents=0 HEAD', log: false).chomp
         else
           # Tag's format is v2.3.4-5-g7685948
           # See git describe man page for more info
-          tagName = tag.split('-')[0].strip()
-          version = tagName.match(params[:tag_version_match])[0]
+          tag_name = tag.split('-')[0].strip
+          version = tag_name.match(params[:tag_version_match])[0]
           # Get a hash of last version tag
-          command = "git rev-list -n 1 #{tagName}"
+          command = "git rev-list -n 1 #{tag_name}"
           hash = Actions.sh(command, log: false).chomp
 
-          UI.message("Found a tag #{tagName} associated with version #{version}")
+          UI.message("Found a tag #{tag_name} associated with version #{version}")
         end
 
         # converts last version string to the int numbers
-        nextMajor = (version.split('.')[0] || 0).to_i
-        nextMinor = (version.split('.')[1] || 0).to_i
-        nextPatch = (version.split('.')[2] || 0).to_i
+        next_major = (version.split('.')[0] || 0).to_i
+        next_minor = (version.split('.')[1] || 0).to_i
+        next_patch = (version.split('.')[2] || 0).to_i
 
         # Get commits log between last version and head
         commits = Helper::SemanticReleaseHelper.git_log('%s', hash)
-        splitted = commits.split("\n");
+        splitted = commits.split("\n")
 
         UI.message("Found #{splitted.length} commits since last release")
         releases = params[:releases]
 
-        for line in splitted
+        splitted.each do |line|
           # conventional commits are in format
           # type: subject (fix: app crash - for example)
           type = line.split(":")[0]
           release = releases[type.to_sym]
 
-          if release == "patch" then
-            nextPatch = nextPatch + 1
-          elsif release == "minor" then
-            nextMinor = nextMinor + 1
-            nextPatch = 0
-          elsif release == "major" then
-            nextMajor = nextMajor + 1
-            nextMinor = 0
-            nextPatch = 0
+          if release == "patch"
+            next_patch += 1
+          elsif release == "minor"
+            next_minor += 1
+            next_patch = 0
+          elsif release == "major"
+            next_major += 1
+            next_minor = 0
+            next_patch = 0
           end
 
-          nextVersion = "#{nextMajor}.#{nextMinor}.#{nextPatch}"
-          UI.message("#{nextVersion}: #{line}")
+          next_version = "#{next_major}.#{next_minor}.#{next_patch}"
+          UI.message("#{next_version}: #{line}")
         end
 
-        nextVersion = "#{nextMajor}.#{nextMinor}.#{nextPatch}"
+        next_version = "#{next_major}.#{next_minor}.#{next_patch}"
 
-        isReleaseable = Helper::SemanticReleaseHelper.semver_gt(nextVersion, version)
+        is_releasable = Helper::SemanticReleaseHelper.semver_gt(next_version, version)
 
         Actions.lane_context[SharedValues::RELEASE_ANALYZED] = true
-        Actions.lane_context[SharedValues::RELEASE_IS_NEXT_VERSION_HIGHER] = isReleaseable
+        Actions.lane_context[SharedValues::RELEASE_IS_NEXT_VERSION_HIGHER] = is_releasable
         # Last release analysis
         Actions.lane_context[SharedValues::RELEASE_LAST_TAG_HASH] = hash
         Actions.lane_context[SharedValues::RELEASE_LAST_VERSION] = version
         # Next release analysis
-        Actions.lane_context[SharedValues::RELEASE_NEXT_MAJOR_VERSION] = nextMajor
-        Actions.lane_context[SharedValues::RELEASE_NEXT_MINOR_VERSION] = nextMinor
-        Actions.lane_context[SharedValues::RELEASE_NEXT_PATCH_VERSION] = nextPatch
-        Actions.lane_context[SharedValues::RELEASE_NEXT_VERSION] = nextVersion
+        Actions.lane_context[SharedValues::RELEASE_NEXT_MAJOR_VERSION] = next_major
+        Actions.lane_context[SharedValues::RELEASE_NEXT_MINOR_VERSION] = next_minor
+        Actions.lane_context[SharedValues::RELEASE_NEXT_PATCH_VERSION] = next_patch
+        Actions.lane_context[SharedValues::RELEASE_NEXT_VERSION] = next_version
 
-        successMessage = "Next version (#{nextVersion}) is higher than last version (#{version}). This version should be released."
-        UI.success(successMessage) if isReleaseable
+        success_message = "Next version (#{next_version}) is higher than last version (#{version}). This version should be released."
+        UI.success(success_message) if is_releasable
 
-        isReleaseable
+        is_releasable
       end
 
       #####################################################
@@ -124,20 +123,20 @@ module Fastlane
             key: :match,
             description: "Match parameter of git describe. See man page of git describe for more info",
             verify_block: proc do |value|
-                UI.user_error!("No match for analyze_commits action given, pass using `match: 'expr'`") unless (value and not value.empty?)
+              UI.user_error!("No match for analyze_commits action given, pass using `match: 'expr'`") unless value && !value.empty?
             end
           ),
           FastlaneCore::ConfigItem.new(
             key: :releases,
             description: "Map types of commit to release (major, minor, patch)",
             default_value: { fix: "patch", feat: "minor" },
-            type: Hash,
+            type: Hash
           ),
           FastlaneCore::ConfigItem.new(
             key: :tag_version_match,
             description: "To parse version number from tag name",
-            default_value: '\d+\.\d+\.\d+',
-          ),
+            default_value: '\d+\.\d+\.\d+'
+          )
         ]
       end
 
@@ -152,7 +151,7 @@ module Fastlane
           ['RELEASE_NEXT_MAJOR_VERSION', 'Major number of the next version'],
           ['RELEASE_NEXT_MINOR_VERSION', 'Minor number of the next version'],
           ['RELEASE_NEXT_PATCH_VERSION', 'Patch number of the next version'],
-          ['RELEASE_NEXT_VERSION', 'Next version string in format (major.minor.patch)'],
+          ['RELEASE_NEXT_VERSION', 'Next version string in format (major.minor.patch)']
         ]
       end
 

data/lib/fastlane/plugin/semantic_release/actions/conventional_changelog.rb

@@ -13,31 +13,30 @@ module Fastlane
 
         # If analyze commits action was not run there will be no version in shared
         # values. We need to run the action to get next version number
-        if !analyzed then
+        unless analyzed
           UI.user_error!("Release hasn't been analyzed yet. Run analyze_commits action first please.")
           # version = other_action.analyze_commits(match: params[:match])
         end
 
-        lastTagHas = lane_context[SharedValues::RELEASE_LAST_TAG_HASH]
+        last_tag_hash = lane_context[SharedValues::RELEASE_LAST_TAG_HASH]
         version = lane_context[SharedValues::RELEASE_NEXT_VERSION]
 
         # Get commits log between last version and head
-        commits = Helper::SemanticReleaseHelper.git_log('%s|%H|%h|%an|%at', lastTagHas)
-        parsed = parseCommits(commits.split("\n"))
+        commits = Helper::SemanticReleaseHelper.git_log('%s|%H|%h|%an|%at', last_tag_hash)
+        parsed = parse_commits(commits.split("\n"))
 
+        commit_url = params[:commit_url]
 
-        commitUrl = params[:commit_url]
-
-        if params[:format] == 'markdown' then
-          result = markdown(parsed, version, commitUrl, params)
+        if params[:format] == 'markdown'
+          result = markdown(parsed, version, commit_url, params)
         elsif params[:format] == 'slack'
-          result = slack(parsed, version, commitUrl, params)
+          result = slack(parsed, version, commit_url, params)
         end
 
         result
       end
 
-      def self.markdown(commits, version, commitUrl, params)
+      def self.markdown(commits, version, commit_url, params)
         sections = params[:sections]
 
         # Begining of release notes
@@ -45,96 +44,94 @@ module Fastlane
         result += "\n"
         result += "(#{Date.today})"
 
-        for type in params[:order]
+        params[:order].each do |type|
           # write section only if there is at least one commit
-          next if !commits.any? { |commit| commit[:type] == type }
+          next if commits.none? { |commit| commit[:type] == type }
 
           result += "\n\n"
           result += "### #{sections[type.to_sym]}"
           result += "\n"
 
-          for commit in commits
-            if commit[:type] == type then
-              authorName = commit[:authorName]
-              shortHash = commit[:shortHash]
-              hash = commit[:hash]
-              link = "#{commitUrl}/#{hash}"
+          commits.each do |commit|
+            next if commit[:type] != type
 
-              result += "- #{commit[:subject]} ([#{shortHash}](#{link}))"
+            author_name = commit[:author_name]
+            short_hash = commit[:short_hash]
+            hash = commit[:hash]
+            link = "#{commit_url}/#{hash}"
 
-              if params[:display_author] then
-                result += "- #{authorName}"
-              end
+            result += "- #{commit[:subject]} ([#{short_hash}](#{link}))"
 
-              result += "\n"
+            if params[:display_author]
+              result += "- #{author_name}"
             end
+
+            result += "\n"
           end
         end
 
-
         result
       end
 
-      def self.slack(commits, version, commitUrl, params)
+      def self.slack(commits, version, commit_url, params)
         sections = params[:sections]
 
         # Begining of release notes
         result = "*#{version} #{params[:title]}* (#{Date.today})"
         result += "\n"
 
-        for type in params[:order]
+        params[:order].each do |type|
           # write section only if there is at least one commit
-          next if !commits.any? { |commit| commit[:type] == type }
+          next if commits.none? { |commit| commit[:type] == type }
 
           result += "\n\n"
           result += "*#{sections[type.to_sym]}*"
           result += "\n"
 
-          for commit in commits
-            if commit[:type] == type then
-              authorName = commit[:authorName]
-              shortHash = commit[:shortHash]
-              hash = commit[:hash]
-              link = "#{commitUrl}/#{hash}"
+          commits.each do |commit|
+            next if commit[:type] != type
 
-              result += "- #{commit[:subject]} (<#{link}|#{shortHash}>)"
+            author_name = commit[:author_name]
+            short_hash = commit[:short_hash]
+            hash = commit[:hash]
+            link = "#{commit_url}/#{hash}"
 
-              if params[:display_author] then
-                result += "- #{authorName}"
-              end
+            result += "- #{commit[:subject]} (<#{link}|#{short_hash}>)"
 
-              result += "\n"
+            if params[:display_author]
+              result += "- #{author_name}"
             end
+
+            result += "\n"
           end
         end
 
-
         result
       end
 
-      def self.parseCommits(commits)
+      def self.parse_commits(commits)
         parsed = []
         # %s|%H|%h|%an|%at
-        for line in commits
+        commits.each do |line|
           splitted = line.split("|")
 
-          subjectSplitted = splitted[0].split(":")
+          subject_splitted = splitted[0].split(":")
 
-          if subjectSplitted.length > 1 then
-            type = subjectSplitted[0]
-            subject = subjectSplitted[1]
+          if subject_splitted.length > 1
+            type = subject_splitted[0]
+            subject = subject_splitted[1]
           else
             type = 'no_type'
-            subject = subjectSplitted[0]
+            subject = subject_splitted[0]
           end
 
           commit = {
-            type: type.strip(),
-            subject: subject.strip(),
+            type: type.strip,
+            subject: subject.strip,
             hash: splitted[1],
-            shortHash: splitted[2],
-            authorName: splitted[3],
-            commitDate: splitted[4],
+            short_hash: splitted[2],
+            author_name: splitted[3],
+            commitDate: splitted[4]
           }
 
           parsed.push(commit)
@@ -143,7 +140,6 @@ module Fastlane
         parsed
       end
 
-
       #####################################################
       # @!group Documentation
       #####################################################
@@ -195,7 +191,7 @@ module Fastlane
               chore: "Building system",
               test: "Testing",
               docs: "Documentation",
-              no_type: "Rest work",
+              no_type: "Rest work"
             },
             type: Hash,
             optional: true
@@ -206,14 +202,14 @@ module Fastlane
             default_value: false,
             type: Boolean,
             optional: true
-          ),
+          )
         ]
       end
 
       def self.output
         # Define the shared values you are going to provide
         # Example
-        [ ]
+        []
       end
 
       def self.return_value

data/lib/fastlane/plugin/semantic_release/helper/semantic_release_helper.rb

@@ -12,23 +12,24 @@ module Fastlane
         command = "git log --pretty='#{pretty}' --reverse #{start}..HEAD"
         Actions.sh(command, log: false).chomp
       end
+
       def self.semver_gt(first, second)
-        firstMajor = (first.split('.')[0] || 0).to_i
-        firstMinor = (first.split('.')[1] || 0).to_i
-        firstPatch = (first.split('.')[2] || 0).to_i
+        first_major = (first.split('.')[0] || 0).to_i
+        first_minor = (first.split('.')[1] || 0).to_i
+        first_patch = (first.split('.')[2] || 0).to_i
 
-        secondMajor = (second.split('.')[0] || 0).to_i
-        secondMinor = (second.split('.')[1] || 0).to_i
-        secondPatch = (second.split('.')[2] || 0).to_i
+        second_major = (second.split('.')[0] || 0).to_i
+        second_minor = (second.split('.')[1] || 0).to_i
+        second_patch = (second.split('.')[2] || 0).to_i
 
         # Check if next version is higher then last version
-        if firstMajor > secondMajor then
+        if first_major > second_major
           return true
-        elsif firstMajor == secondMajor then
-          if firstMinor > secondMinor then
+        elsif first_major == second_major
+          if first_minor > second_minor
             return true
-          elsif firstMinor == secondMinor then
-            if firstPatch > secondPatch then
+          elsif first_minor == second_minor
+            if first_patch > second_patch
               return true
             end
           end
@@ -36,8 +37,9 @@ module Fastlane
 
         return false
       end
+
       def self.semver_lt(first, second)
-        return !semver_gt(first,second)
+        return !semver_gt(first, second)
       end
     end
   end

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

@@ -1,5 +1 @@
-module Fastlane
-  module SemanticRelease
-    VERSION = "1.0.1"
-  end
-end
+module Fastlane module SemanticRelease VERSION="1.0.2" end end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-semantic_release
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jiří Otáhal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry