fastlane-plugin-changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 403f4a4eb9682c5266b064684cee9bd8229d6fa8
+  data.tar.gz: 791cb83f660b2d973251645b8ce15864d270f7e4
+SHA512:
+  metadata.gz: 0648cc5b024200347b5e152c0eddbcd9acb72e4f6f0c981ac8d8e69bb867ce02a9ddeab78bff6364019779d2fb1fdf74befed8497be608b9eeeb8f92e958eb0b
+  data.tar.gz: c72e5212b39488c5a2742f5436045557a12507e0900016ff5cb9cd36823d4fe5f607ef2451761507ac70c076291ba2c434a4a1436508adcf55daf1ec4f37543c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pavel Procházka <pprochazka72@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,75 @@
+# changelog plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-changelog)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-changelog`, add it to your project by running:
+
+```bash
+fastlane add_plugin changelog
+```
+
+## About changelog
+
+This plugin is inspired and based on [Keep a CHANGELOG](http://keepachangelog.com/) project. [Keep a CHANGELOG](http://keepachangelog.com/) proposes a standardised format for keeping change log of your project repository in CHANGELOG.md file. This file contains a curated, chronologically ordered list of notable changes for each version of a project in human readable format.
+
+Since [Keep a CHANGELOG](http://keepachangelog.com/) project proposes a well-defined structure with _sections_ (e.g.: `[Unreleased]`, `0.3.0]`) and _subsections_ (`Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`) it opens up an opportunity to automate reading from/writing to CHANGELOG.md with [`fastlane`](https://fastlane.tools). 
+
+## Getting started
+1. `cd` to your project folder
+2. `touch CHANGELOG.md`
+3. open CHANGELOG.md in your favourite text editor
+4. paste the following: `## [Unreleased]`
+
+## Actions
+
+### read_changelog
+
+Reads the content of a section from your project's `CHANGELOG.md` file. `CHANGELOG.md` must follow structure proposed by [Keep a CHANGELOG](http://keepachangelog.com/) project. 
+
+``` ruby
+read_changelog	# Reads the "Unreleased" section from CHANGELOG.md in your project's folder
+```
+
+``` ruby
+read_changelog(
+  changelog_path: './custom_folder/CHANGELOG.md',	# Specify path to CHANGELOG.md
+  section_identifier: '[Unreleased]',	# Specify what section to read
+  excluded_markdown_elements: '["###"]'	# Specify which markdown elements should be excluded
+)
+```
+ 
+ Use the output of this action in conjunction with for example [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot#uploading-builds) to upload your change log to TestFlight or with [`github_release`](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Actions.md#github-releases) to create a new release on Github.
+ 
+### write_changelog
+*Coming soon*
+
+
+## Example
+As a developer you have to **remember to keep your CHANGELOG.md up-to-date** with whatever features, bug fixes etc. your repo contains and let [`fastlane`](https://fastlane.tools) to do the rest. 
+
+``` ruby
+lane :beta do
+  gym
+  changelog = read_changelog
+  pilot(changelog: changelog)
+  # write_changelog
+end
+```
+
+## 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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/changelog.rb

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

data/lib/fastlane/plugin/changelog/actions/changelog_action.rb

@@ -0,0 +1,35 @@
+module Fastlane
+  module Actions
+    class ChangelogAction < Action
+      def self.run(params)
+        UI.message("The changelog plugin is working!")
+      end
+
+      def self.description
+        "Automate changes to your project CHANGELOG.md"
+      end
+
+      def self.authors
+        ["Pavel Prochazka"]
+      end
+
+      def self.available_options
+        [
+          # FastlaneCore::ConfigItem.new(key: :your_option,
+          #                         env_name: "CHANGELOG_YOUR_OPTION",
+          #                      description: "A description of your option",
+          #                         optional: false,
+          #                             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://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/changelog/actions/read_changelog.rb

@@ -0,0 +1,116 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      READ_CHANGELOG_SECTION_CONTENT = :READ_CHANGELOG_SECTION_CONTENT
+    end
+
+    class ReadChangelogAction < Action
+
+      def self.run(params) 
+        changelog_path = params[:changelog_path] unless (params[:changelog_path].to_s.empty?)
+        UI.error("CHANGELOG.md at path '#{changelog_path}' does not exist") unless (File.exist?(changelog_path))
+        
+        section_identifier = params[:section_identifier] unless (params[:section_identifier].to_s.empty?)
+        escaped_section_identifier = section_identifier[/\[(.*?)\]/,1]
+
+        excluded_markdown_elements = params[:excluded_markdown_elements]
+
+        UI.message "Starting to read #{section_identifier} section from '#{changelog_path}' "
+
+        section_content = ""
+        found_section = false
+        File.open(changelog_path, "r") do |file|
+          file.each_line do |line|
+
+            if found_section
+              break if line =~ /\#{2}\s?\[(.*?)\]/
+              if !excluded_markdown_elements.nil? && !excluded_markdown_elements.empty?
+                markdownless_line = remove_markdown(line, excluded_markdown_elements)
+                section_content.concat(markdownless_line)
+              else 
+                section_content.concat(line)
+              end 
+            end 
+
+            if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
+              found_section = true
+            end
+
+          end
+        end
+
+        UI.error("Could not find #{section_identifier} section in your CHANGELOG.md") unless (!section_content.empty?)
+
+        UI.success("Finished reading #{section_identifier} section from '#{changelog_path}'") unless (section_content.empty?)
+
+        Actions.lane_context[SharedValues::READ_CHANGELOG_SECTION_CONTENT] = section_content
+      end
+
+      def self.remove_markdown(line, excluded_markdown_elements)
+        markdownless_line = line
+        excluded_markdown_elements.each do |element|
+          if line =~ /^#{element}/
+            markdownless_line = markdownless_line.gsub(element.to_s, "")
+          end
+        end 
+
+        markdownless_line
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Reads content of a section from your project CHANGELOG.md file"
+      end
+
+      def self.details
+        "This action is inspired by \"Keep a CHANGELOG\" project (see http://keepachangelog.com/). \"Keep a CHANGELOG\" introduces a structed CHANGELOG.md file, 
+        which contains a curated, chronologically ordered list of notable changes for each version of a project. Use this action to read content of a section 
+        from your project's CHANGELOG.md."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :changelog_path,
+                                       env_name: "FL_READ_CHANGELOG_PATH_TO_CHANGELOG",
+                                       description: "The path to your project CHANGELOG.md",
+                                       is_string: true,
+                                       default_value: "./CHANGELOG.md", 
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :section_identifier,
+                                       env_name: "FL_READ_CHANGELOG_SECTION_IDENTIFIER",
+                                       description: "The unique section identifier to read content of",
+                                       is_string: true,
+                                       default_value: "[Unreleased]",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("Sections (##) in CHANGELOG format must be encapsulated in []") unless (value.start_with?("[") && value.end_with?("]"))
+                                          UI.user_error!("Sections (##) in CHANGELOG format cannot be empty") unless (!value[/\[(.*?)\]/,1].empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :excluded_markdown_elements,
+                                       env_name: "FL_READ_CHANGELOG_EXCLUDED_MARKDOWN_ELEMENTS",
+                                       description: "Markdown elements you wish to exclude from the output",
+                                       type: Array,
+                                       default_value: ["###"],
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['READ_CHANGELOG_SECTION_CONTENT', 'Contains text from a section of your CHANGELOG.md file']
+        ]
+      end
+
+      def self.authors
+        ["pajapro"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/changelog/helper/changelog_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class ChangelogHelper
+      # class methods that you define here become available in your action
+      # as `Helper::ChangelogHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the changelog plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Prochazka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-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: 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'
+  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: 1.96.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.96.0
+description: 
+email: pprochazka72@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fastlane/plugin/changelog/actions/changelog_action.rb
+- lib/fastlane/plugin/changelog/actions/read_changelog.rb
+- lib/fastlane/plugin/changelog/helper/changelog_helper.rb
+- lib/fastlane/plugin/changelog/version.rb
+- lib/fastlane/plugin/changelog.rb
+- README.md
+- LICENSE
+homepage: https://github.com/pajapro/fastlane-plugin-changelog
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Automate changes to your project CHANGELOG.md
+test_files: []
+has_rdoc: