fastlane-plugin-semantic_release 1.1.8 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ae75301af55462a4562ca754bb60105e9946a4e5900cd700072cc2ee291269
-  data.tar.gz: 2c13cedf37198623568b475fb6cecf1f597119989f57811c22861689ac846c30
+  metadata.gz: 9a1dd33a05c2a6864d2a60b13cb2fc1b6bae08e1549075bc5355b67c4e023e4c
+  data.tar.gz: a8c22242d8d8304f211da2ef3229505926763468856a223d9543cd545b6e3cdf
 SHA512:
-  metadata.gz: c37e53c9830f14b7573b207a5efc90a26f2e03a9315bbd1386ff20014e499e355c0bd9d98d31a7e176c91103d5a9359736f20c20cff142849532d270ac22a116
-  data.tar.gz: e38aa4f0067a1f84399bc5c05b2bd48782abdf73fa367d83cea1c39a44e87a00140d9babafc73d5252a219593dd0b35eadb9ae3f72648c361fc69c9d5ed1cd2f
+  metadata.gz: '0009044f8a040373ea1bf0601a8a3b38ad5e6269b0c78daded0c2b2a78eada4667e906e37d47f7f54711615c620fd7c16ccce4b3e8db50b27a440bc0163ac60f'
+  data.tar.gz: 342c0423b25bfe6ff9e0aa4dd3ae7a7fedbfc5bcd7c23aa16faacd5abcb045e8cd8b75a3ba8e2dd92c14c0508aad559a6fdd8d280cb84525c211f7e171a3b0e1

data/README.md

@@ -4,7 +4,7 @@
 
 ## Getting Started
 
-```bash
+```
 fastlane add_plugin semantic_release
 ```
 
@@ -18,19 +18,30 @@ Automated version managment and generator of release notes. Inspired by [semanti
 
 ## Available Actions
 
-### conventional_changelog
+### `conventional_changelog`
 
 - parses all commits since last version
-- group those commits by their type (fix, feat, docs, refactor, chore, etc)
+- groups those commits by their type (fix, feat, docs, refactor, chore, etc)
 - and creates formated release notes either in markdown or in slack format
 
+Available parameters:
+
+- `format: 'slack|markdown|plain'` (defaults to `markdown`). This formats the changelog for the destination you need. If you're using this for TestFlight changelogs, we suggest using the `plain` option
+- `title: 'My Title'` - is appended to the release notes title, "1.1.8 My Title (YYYY-MM-DD)"
+- `display_title: true|false` (defaults to true) - allows you to hide the entire first line of the changelog
+- `display_links: true|false` (defaults to true) - allows you to hide links to commits from your changelog
+- `commit_url: 'https://github.com/username/repository/commit'` - prepended to the commit ID to build usable links
+- View other options by searching for `available_options` in `conventional_changelog.rb`
+
+Example:
+
 ```
 notes = conventional_changelog(format: 'slack', title: 'Android Alpha')
 ```
 
 <img src="https://raw.githubusercontent.com/xotahal/fastlane-plugin-semantic_release/master/docs/Changelog.png" />
 
-### analyze_commits
+### `analyze_commits`
 
 - analyzes your git history
 - finds last tag on current branch (for example ios/beta/1.3.2)
@@ -38,11 +49,13 @@ notes = conventional_changelog(format: 'slack', title: 'Android Alpha')
 - 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
+
 ```
 isReleasable = analyze_commits(match: 'ios/beta*')
 ```
 
-It provides these variables in lane_context.
+It provides these variables in `lane_context`.
+
 ```
 ['RELEASE_ANALYZED', 'True if commits were analyzed.'],
 ['RELEASE_IS_NEXT_VERSION_HIGHER', 'True if next version is higher then last version'],
@@ -53,12 +66,18 @@ It provides these variables in lane_context.
 ['RELEASE_NEXT_PATCH_VERSION', 'Patch number of the next version'],
 ['RELEASE_NEXT_VERSION', 'Next version string in format (major.minor.patch)'],
 ```
-`next_version = lane_context[SharedValues::RELEASE_NEXT_VERSION]`
 
+And you can access these like this:
+
+`next_version = lane_context[SharedValues::RELEASE_NEXT_VERSION]`
 
 <img src="https://raw.githubusercontent.com/xotahal/fastlane-plugin-semantic_release/master/docs/Analyze.png" />
 
-### Questions
+## Tests
+
+To run the test suite (contained in `./spec`), call `bundle exec rake`
+
+## Questions
 
 If you need anything ping us on [twitter](http://bit.ly/t-xotahal).
 

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

@@ -31,147 +31,138 @@ module Fastlane
         parsed = parse_commits(commits)
 
         commit_url = params[:commit_url]
+        format = params[:format]
 
-        if params[:format] == 'markdown'
-          result = markdown(parsed, version, commit_url, params)
-        elsif params[:format] == 'slack'
-          result = slack(parsed, version, commit_url, params)
-        end
+        result = note_builder(format, parsed, version, commit_url, params)
 
         result
       end
 
-      def self.markdown(commits, version, commit_url, params)
+      def self.note_builder(format, commits, version, commit_url, params)
         sections = params[:sections]
 
-        title = version
-        title += " #{params[:title]}" if params[:title]
+        result = ""
 
         # Begining of release notes
-        result = "# #{title} (#{Date.today})"
-        result += "\n"
+        if params[:display_title] == true
+          title = version
+          title += " #{params[:title]}" if params[:title]
+          title += " (#{Date.today})"
+
+          result = style_text(title, format, "title").to_s
+          result += "\n\n"
+        end
 
         params[:order].each do |type|
           # write section only if there is at least one commit
           next if commits.none? { |commit| commit[:type] == type }
 
-          result += "\n\n"
-          result += "### #{sections[type.to_sym]}"
+          result += style_text(sections[type.to_sym], format, "heading").to_s
           result += "\n"
 
           commits.each do |commit|
             next if commit[:type] != type || commit[:is_merge]
 
-            author_name = commit[:author_name]
-            short_hash = commit[:short_hash]
-            hash = commit[:hash]
-            link = "#{commit_url}/#{hash}"
-
             result += "-"
 
             unless commit[:scope].nil?
-              result += " **#{commit[:scope]}:**"
+              formatted_text = style_text("#{commit[:scope]}:", format, "bold").to_s
+              result += " #{formatted_text}"
             end
 
-            result += " #{commit[:subject]} ([#{short_hash}](#{link}))"
+            result += " #{commit[:subject]}"
 
-            if params[:display_author]
-              result += "- #{author_name}"
+            if params[:display_links] == true
+              styled_link = build_commit_link(commit, commit_url, format).to_s
+              result += " (#{styled_link})"
             end
 
-            result += "\n"
-          end
-        end
-
-        if commits.any? { |commit| commit[:is_breaking_change] == true }
-          result += "\n\n"
-          result += "### BREAKING CHANGES"
-          result += "\n"
-
-          commits.each do |commit|
-            next unless commit[:is_breaking_change]
-
-            author_name = commit[:author_name]
-            short_hash = commit[:short_hash]
-            hash = commit[:hash]
-            link = "#{commit_url}/#{hash}"
-
-            result += "- #{commit[:breaking_change]} ([#{short_hash}](#{link}))"
-
             if params[:display_author]
-              result += "- #{author_name}"
+              result += " - #{commit[:author_name]}"
             end
 
             result += "\n"
           end
+          result += "\n"
         end
 
-        result
-      end
-
-      def self.slack(commits, version, commit_url, params)
-        sections = params[:sections]
-
-        # Begining of release notes
-        result = "*#{version} #{params[:title]}* (#{Date.today})"
-        result += "\n"
-
-        params[:order].each do |type|
-          # write section only if there is at least one commit
-          next if commits.none? { |commit| commit[:type] == type }
-
-          result += "\n\n"
-          result += "*#{sections[type.to_sym]}*"
+        if commits.any? { |commit| commit[:is_breaking_change] == true }
+          result += style_text("BREAKING CHANGES", format, "heading").to_s
           result += "\n"
 
           commits.each do |commit|
-            next if commit[:type] != type || commit[:is_merge]
-
-            author_name = commit[:author_name]
-            short_hash = commit[:short_hash]
-            hash = commit[:hash]
-            link = "#{commit_url}/#{hash}"
-
-            result += "-"
+            next unless commit[:is_breaking_change]
+            result += "- #{commit[:breaking_change]}" # This is the only unique part of this loop
 
-            unless commit[:scope].nil?
-              result += " *#{commit[:scope]}:*"
+            if params[:display_links] == true
+              styled_link = build_commit_link(commit, commit_url, format).to_s
+              result += " (#{styled_link})"
             end
 
-            result += " #{commit[:subject]} (<#{link}|#{short_hash}>)"
-
             if params[:display_author]
-              result += "- #{author_name}"
+              result += " - #{commit[:author_name]}"
             end
 
             result += "\n"
           end
-        end
 
-        if commits.any? { |commit| commit[:is_breaking_change] == true }
-          result += "\n\n"
-          result += "*BREAKING CHANGES*"
           result += "\n"
+        end
 
-          commits.each do |commit|
-            next unless commit[:is_breaking_change]
-
-            author_name = commit[:author_name]
-            short_hash = commit[:short_hash]
-            hash = commit[:hash]
-            link = "#{commit_url}/#{hash}"
-
-            result += "- #{commit[:breaking_change]} (<#{link}|#{short_hash}>)"
+        # Trim any trailing newlines
+        result = result.rstrip!
 
-            if params[:display_author]
-              result += "- #{author_name}"
-            end
+        result
+      end
 
-            result += "\n"
+      def self.style_text(text, format, style)
+        # formats the text according to the style we're looking to use
+
+        # Skips all styling
+        case style
+        when "title"
+          if format == "markdown"
+            "# #{text}"
+          elsif format == "slack"
+            "*#{text}*"
+          else
+            text
+          end
+        when "heading"
+          if format == "markdown"
+            "### #{text}"
+          elsif format == "slack"
+            "*#{text}*"
+          else
+            "#{text}:"
           end
+        when "bold"
+          if format == "markdown"
+            "**#{text}**"
+          elsif format == "slack"
+            "*#{text}*"
+          else
+            text
+          end
+        else
+          text # catchall, shouldn't be needed
         end
+      end
 
-        result
+      def self.build_commit_link(commit, commit_url, format)
+        # formats the link according to the output format we need
+        short_hash = commit[:short_hash]
+        hash = commit[:hash]
+        url = "#{commit_url}/#{hash}"
+
+        case format
+        when "slack"
+          "<#{url}|#{short_hash}>"
+        when "markdown"
+          "[#{short_hash}](#{url})"
+        else
+          url
+        end
       end
 
       def self.parse_commits(commits)
@@ -215,7 +206,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(
             key: :format,
-            description: "You can use either markdown or slack",
+            description: "You can use either markdown, slack or plain",
             default_value: "markdown",
             optional: true
           ),
@@ -258,6 +249,20 @@ module Fastlane
             default_value: false,
             type: Boolean,
             optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :display_title,
+            description: "Whether you want to hide the title/header with the version details at the top of the changelog",
+            default_value: true,
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :display_links,
+            description: "Whether you want to display the links to commit IDs",
+            default_value: true,
+            type: Boolean,
+            optional: true
           )
         ]
       end

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

@@ -1 +1 @@
-module Fastlane module SemanticRelease VERSION = "1.1.8" end end
+module Fastlane module SemanticRelease VERSION = "1.5.1" end end

metadata

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