fastlane-plugin-write_changelog_from_commits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73e69f7387e4b8d41ea6eb23607fd00bef32236c59d7953124357ccaa97f0424
+  data.tar.gz: abe9aa127f6cc3db8c92133a928157fae94c0fb3fa1f986dc8d487da50f4369e
+SHA512:
+  metadata.gz: 76e90f86ac0dc15d1097fec33486994fde5aa3fcae55dc4d8a331fb638ede1059d984ec7b703b0919c697699fc094456465cf636beb19320e50fcf54611d6c52
+  data.tar.gz: 032fd1577b7ee7b1872f264a484e323b6d5a1efe7d810faa644266b2dfcec42fb9d18d0492acc128759d1cc75ccd98a46b15bffa77bfc1da060db05893784b51

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lewis Bright <lewis_bright@yahoo.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,52 @@
+# write_changelog_from_commits plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-write_changelog_from_commits)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-write_changelog_from_commits`, add it to your project by running:
+
+```bash
+fastlane add_plugin write_changelog_from_commits
+```
+
+## About write_changelog_from_commits
+
+Writes a changelog by pattern matching on git commits since the last tag. Organises these into sections and creates a changelog with the same name as the current version code
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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)
+
+## 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).

data/lib/fastlane/plugin/write_changelog_from_commits.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/write_changelog_from_commits/version'
+
+module Fastlane
+  module WriteChangelogFromCommits
+    # 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::WriteChangelogFromCommits.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/write_changelog_from_commits/actions/write_changelog_from_commits_action.rb

@@ -0,0 +1,142 @@
+require 'fastlane/action'
+require_relative '../helper/write_changelog_from_commits_helper'
+
+module Fastlane
+  module Actions
+    class WriteChangelogFromCommitsAction < Action
+      OTHER_SECTION = "Other"
+
+      def self.run(params)
+        from = Actions.last_git_tag_name
+        UI.verbose("Found the last Git tag: #{from}")
+        to = 'HEAD'
+
+        if params[:path].nil?
+          UI.message("No path provided, using default at '/'")
+          params[:path] = './' unless params[:path]
+        end
+
+        params[:commit_prefixes] ||= []
+
+        Dir.chdir(params[:path]) do
+          changelog = Actions.git_log_between("%B", from, to, nil, nil, nil)
+          changelog = changelog.gsub("\n\n", "\n") if changelog # as there are duplicate newlines
+          raise "No logs found since last tag" if changelog.strip.empty?
+
+          raw_release_notes = create_raw_release_notes(changelog, params[:commit_prefixes])
+
+          release_notes = create_release_notes(raw_release_notes)
+          Actions.lane_context[SharedValues::FL_CHANGELOG] = release_notes
+          if params[:quiet] == false
+            UI.message(release_notes)
+          end
+
+          if params[:version_code]
+            write_release_notes(release_notes, params[:version_code], params[:changelog_dir])
+          else
+            UI.message("No version code provided, so could not write file")
+          end
+          release_notes
+        end
+      end
+
+      def self.create_raw_release_notes(changelog, commit_prefixes)
+        raw_release_notes = commit_prefixes.to_h { |p| [p.capitalize, []] }
+        raw_release_notes[OTHER_SECTION] = []
+        changelog.each_line do |line|
+          section_exists = false
+          commit_prefixes.each do |prefix|
+            next unless line.downcase.start_with?(prefix.downcase)
+
+            raw_release_notes[prefix.capitalize] << line.slice(prefix.length..line.length).strip
+            section_exists = true
+            break
+          end
+          raw_release_notes[OTHER_SECTION] << line.strip unless section_exists
+        end
+        raw_release_notes
+      end
+
+      def self.create_release_notes(raw_release_notes)
+        release_notes = ""
+        raw_release_notes.keys.each do |section_title|
+          next if raw_release_notes[section_title].empty?
+          release_notes << "<u>#{section_title}</u>\n"
+          release_notes << "#{raw_release_notes[section_title].join("\n")}\n\n"
+        end
+        release_notes
+      end
+
+      def self.write_release_notes(release_notes, version_code, changelog_dir)
+        File.open(File.join(changelog_dir, "#{version_code}.txt"), "w") do |f|
+          f.write(release_notes)
+        end
+        UI.message("Written release notes to #{version_code}.txt")
+      end
+
+      def self.description
+        "Writes a changelog file by pattern matching on git commits since the last tag."
+      end
+
+      def self.authors
+        ["Lewis Bright"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "This plugin will search through all of your commits since the last tag. It will pattern match on keywords at the beginning in order to generate different secions of the changelog (bugfix, feature etc). Then it will create a new file in the changelogs directory that is named after the current version, and write the contents of the changelog"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :path,
+            env_name: 'write_changelog_from_commits_PATH',
+            description: 'Path of the git repository',
+            optional: true,
+            default_value: './'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :quiet,
+            env_name: 'write_changelog_from_commits_TAG_QUIET',
+            description: 'Whether or not to disable changelog output',
+            optional: true,
+            default_value: false,
+            is_string: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :changelog_dir,
+            env_name: 'write_changelog_from_commits_CHANGELOG_DIR',
+            description: 'Path to write new changelogs',
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :commit_prefixes,
+            env_name: "write_changelog_from_commits_PREFIXES",
+            description: "List of prefixes to group in the changelog",
+            type: Array,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :version_code,
+            env_name: "write_changelog_from_commits_VERSION_CODE",
+            description: "Version code used to create file",
+            optional: true
+          )
+        ]
+      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)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/write_changelog_from_commits/helper/write_changelog_from_commits_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class WriteChangelogFromCommitsHelper
+      # class methods that you define here become available in your action
+      # as `Helper::WriteChangelogFromCommitsHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the write_changelog_from_commits plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-write_changelog_from_commits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lewis Bright
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-25 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.168.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.168.0
+description:
+email: lewis_bright@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/write_changelog_from_commits.rb
+- lib/fastlane/plugin/write_changelog_from_commits/actions/write_changelog_from_commits_action.rb
+- lib/fastlane/plugin/write_changelog_from_commits/helper/write_changelog_from_commits_helper.rb
+- lib/fastlane/plugin/write_changelog_from_commits/version.rb
+homepage: https://github.com/Lewis-Bright/fastlane-plugin-write-changelog-from-commits
+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.1.4
+signing_key:
+specification_version: 4
+summary: Writes a changelog by pattern matching on git commits since the last tag.
+  Organises these into sections and creates a changelog with the same name as the
+  current version code
+test_files: []