fastlane-plugin-gitlab_changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad928ae4d6868eb41ebee3905d1bea6f2bc457cbb9e8c11dde54b2a1a7d66026
+  data.tar.gz: ce9ff718fd01887a1901672e0701307a8d49a4a5b2ed97e5e8625b1d81b9a9c6
+SHA512:
+  metadata.gz: b88e17af0bc8aaa9372fbcdbf85aaf18302fc6e1071b37448fda47f9aad9339efe17f7e4cb6a23cf237ec2a32e9b363b978f5b89e0e99c6cd6ceeae0d09298e4
+  data.tar.gz: 77fa75cfeb39037397b182270959a54f9f7da583d502a809143f0b4cdf61d7005d2c77e2ca3a06a256a2adc4ecb78e1fd79ec736e4d8d9345cd7f41cf69d1c5a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Treatwell <zilvinas.sebeika@wahanda.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 @@
+# gitlab_changelog plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-gitlab_changelog)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-gitlab_changelog`, add it to your project by running:
+
+```bash
+fastlane add_plugin gitlab_changelog
+```
+
+## About gitlab_changelog
+
+Get commit changelog using GitLab API
+
+Plugin is particularly useful if you use [Shallow Cloning](https://docs.gitlab.com/ee/ci/large_repositories/#shallow-cloning) and have small number, like `GIT_DEPTH: "1"`, setting in your GitLab CI config.
+
+In such case, `Fastlane's` native [`changelog_from_git_commits`](https://docs.fastlane.tools/actions/changelog_from_git_commits/#changelog_from_git_commits) action is not helpful, because CI machine does not have a full git history to construct a changelog.
+
+This plugin resolves latest release branch using [`git ls-remote`](https://git-scm.com/docs/git-ls-remote.html) (always available).
+
+```bash
+git ls-remote --sort='v:refname' --heads origin refs/heads/release/*```
+```
+refs/heads/release/4.267.0
+refs/heads/release/4.269.0
+refs/heads/release/4.269.1
+refs/heads/release/4.270.0
+refs/heads/release/4.270.1
+
+And then, fetches a changelog (JSON) between the current branch and the latest release branch using [`GitLab API`](https://docs.gitlab.com/ee/api/repositories.html#compare-branches-tags-or-commits).
+
+In a case then CI _is_ on release branch currently - a changelog between current and previous release branches is constructed.
+
+## Usage:
+```
+change_log = gitlab_changelog(
+    current_branch: "develop",
+    compare_branch_prefix: "release",
+    gitlab_API_baseURL: "http://git.yourcompany.net/api/v4",
+    gitlab_project_id: "123",
+    gitlab_API_token: "secret_gitlab_token" 
+  )
+ ```
+ 
+ **Params:**
+ * _current_branch_ : `Actions.git_branch` or `ENV['CI_COMMIT_REF_NAME']` (default)
+ * _compare_branch_prefix_ : default is `release` to compare against `release/*.*.*` branches
+ * _gitlab_API_baseURL_ : a root URL for your GitLab API
+ * _gitlab_project_id_ : `ENV['CI_PROJECT_ID']` (default)
+ * _gitlab_API_token_ : Create a GitLab API Token and define it as a variable on your CI environment like `ENV['MY_GITLAB_API_TOKEN']`
+
+ **Output:**
+ _Fetching changeLog from: release/4.270.1 to: develop (GET http://git.yourcompany.net/api/v4/projects/123/repository/compare)_
+ 
+ DEV0001 Feature 2 (Thom Yorke) 2019-12-31
+ DEV0002 Feature 1 (Jonny Greenwood) 2019-12-30
+
+## 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/gitlab_changelog.rb

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

data/lib/fastlane/plugin/gitlab_changelog/actions/gitlab_changelog_action.rb

@@ -0,0 +1,80 @@
+require 'fastlane/action'
+require_relative '../helper/gitlab_changelog_helper'
+
+module Fastlane
+  module Actions
+    class GitlabChangelogAction < Action
+      def self.run(params)
+        require 'excon'
+
+        to_branch = params[:current_branch].to_s
+        from_branch = Helper::GitlabChangelogHelper.get_from_branch(params[:compare_branch_prefix].to_s, to_branch)
+        endpoint = "#{params[:gitlab_API_baseURL]}/projects/#{params[:gitlab_project_id]}/repository/compare"
+
+        UI.message("Fetching changeLog from: #{from_branch} to: #{to_branch} (GET #{endpoint})")
+
+        compare_resp = Excon.get(
+          endpoint,
+          query: {
+            from: from_branch,
+            to: to_branch,
+            private_token: params[:gitlab_API_token]
+          }
+        )
+
+        change_log = JSON.parse(compare_resp.body)['commits']
+                         .reject { |c| c['title'].start_with?("Merge branch") } # Filter out merges
+                         .sort_by { |c| -Date.parse(c['created_at']).to_time.to_i }
+                         .map { |c| "#{c['title']} (#{c['author_name']}) #{Date.parse(c['created_at'])}" }
+                         .join("\n")
+
+        puts("\n#{change_log}")
+
+        change_log
+      end
+
+      def self.description
+        "Get changelog using GitLab API"
+      end
+
+      def self.authors
+        ["Žilvinas Sebeika"]
+      end
+
+      def self.return_value
+        "String containing commit messages (excluding branch merges). Separated by new_line"
+      end
+
+      def self.details
+        "Fetch changelog between branches using GitLab API. Useful if you have GIT_DEPTH: 1 setting in CI config"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :current_branch,
+                                        env_name: "CI_COMMIT_REF_NAME",
+                                        description: "Current branch",
+                                        optional: false),
+          FastlaneCore::ConfigItem.new(key: :compare_branch_prefix,
+                                        default_value: "release",
+                                        description: "Compare branch prefix. Usually 'release' to compare against 'release/*.*.*' branches",
+                                        optional: false),
+          FastlaneCore::ConfigItem.new(key: :gitlab_API_baseURL,
+                                        description: "GitLab API base URL (http://<gitLab_host>/api/v4)",
+                                        optional: false),
+          FastlaneCore::ConfigItem.new(key: :gitlab_project_id,
+                                        env_name: "CI_PROJECT_ID",
+                                        description: "GitLab Project ID (ENV['CI_PROJECT_ID'])",
+                                        optional: false),
+          FastlaneCore::ConfigItem.new(key: :gitlab_API_token,
+                                        description: "GitLab API Token (ENV['GITLAB_API_TOKEN'])",
+                                        optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/gitlab_changelog/helper/gitlab_changelog_helper.rb

@@ -0,0 +1,18 @@
+module Fastlane
+  module Helper
+    class GitlabChangelogHelper
+      def self.get_depth(name, current_branch)
+        current_branch.start_with?(name) ? 2 : 1
+      end
+
+      # If the current branch is a branch we're comparing to ("release/*.*.*" for example) -
+      # then pick depth = 2 to get a previous version number for the changelog.
+      # Otherwise - use the latest version as a reference branch.
+      def self.get_from_branch(name, current_branch)
+        depth = get_depth(name, current_branch)
+        reference_branch = Action.sh("git ls-remote --sort='v:refname' --quiet --heads origin refs/heads/#{name}/* | tail -n #{depth} | head -n 1 | awk '{ printf \"%s\", $2 }' | rev | cut -d/ -f1 | rev | xargs echo -n")
+        return "#{name}/#{reference_branch}"
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-gitlab_changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Žilvinas Sebeika
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-02 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.136.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.136.0
+description: 
+email: zilvinas.sebeika@wahanda.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/gitlab_changelog.rb
+- lib/fastlane/plugin/gitlab_changelog/actions/gitlab_changelog_action.rb
+- lib/fastlane/plugin/gitlab_changelog/helper/gitlab_changelog_helper.rb
+- lib/fastlane/plugin/gitlab_changelog/version.rb
+homepage: https://github.com/treatwell/fastlane-plugin-gitlab_changelog.git
+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.1
+signing_key: 
+specification_version: 4
+summary: Get changelog using GitLab API
+test_files: []