fastlane-plugin-gitlab_release 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04addcc3e215fcfe9f9568b812190a02646cdb08a0f9772681945a2ea9794cca
+  data.tar.gz: 97d3ab9bb0e4f95c5a3e1a1462cf6362ef988b9e8db42d118433c9b9edce5ad1
+SHA512:
+  metadata.gz: 4010dcb73ad145d6d95cb3fbbc613870d3fe7190a35d696b767fca87a98b288e01969fcb856918214653d1da04bdb6b856d548fc9eeae841e9aacd343dde14a0
+  data.tar.gz: 362c2397ba9e5c22b55bdee42e0a93acfcaad527c270de9795df641507b5330fc95df82884b3f46e10ae50066b4621c62aa968fed68b70f0364e4cc56989d26f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrea Del Fante <andreadelfante94@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,52 @@
+# gitlab_release plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-gitlab_release)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-gitlab_release`, add it to your project by running:
+
+```bash
+fastlane add_plugin gitlab_release
+```
+
+## About gitlab_release
+
+Fastlane wrapper of gitlab-release-tools
+
+**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/gitlab_release.rb

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

data/lib/fastlane/plugin/gitlab_release/actions/gitlab_release_changelog.rb

@@ -0,0 +1,129 @@
+require 'fastlane/action'
+require_relative '../helper/gitlab_release_helper'
+
+module Fastlane
+  module Actions
+    class GitlabReleaseChangelogAction < Action
+      def self.run(params)
+        require 'gitlab/release/changelog/generator'
+
+        endpoint = params[:endpoint] || ENV["GITLAB_API_ENDPOINT"] || ENV["CI_API_V4_URL"]
+        private_token = params[:private_token] || ENV["GITLAB_API_PRIVATE_TOKEN"]
+        version_name = params[:version_name]
+        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+        include_mrs = params[:include_mrs]
+        include_issues = params[:include_issues]
+        split_key = params[:split_key]
+        filtering_labels = params[:filtering_labels]
+        filtering_mrs_labels = params[:filtering_mrs_labels]
+        filtering_issues_labels = params[:filtering_issues_labels]
+
+        array_labels = filtering_labels.split(split_key) unless filtering_labels.empty?
+        array_mrs_labels = filtering_mrs_labels.split(split_key) unless filtering_mrs_labels.empty?
+        array_issues_labels = filtering_issues_labels.split(split_key) unless filtering_issues_labels.empty?
+
+        changelog_generator = Gitlab::Release::Changelog::Generator.new(endpoint, private_token)
+
+        UI.message("Creating changelog for version '#{version_name}'.")
+        changelog = changelog_generator.changelog(version_name,
+                                                  project_id: project_id,
+                                                  include_mrs: include_mrs,
+                                                  include_issues: include_issues,
+                                                  filtering_labels: array_labels,
+                                                  filtering_mrs_labels: array_mrs_labels,
+                                                  filtering_issues_labels: array_issues_labels)
+
+        UI.success("Generated changelog for #{version_name} successfully! :)")
+        changelog
+      end
+
+      def self.description
+        "Generate the changelog of a specific version"
+      end
+
+      def self.details
+        "This action generate the changelog from a specified version name."
+      end
+
+      def self.authors
+        ["Andrea Del Fante"]
+      end
+
+      def self.return_value
+        "Return a 'Entries' object containing changelogs"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :endpoint,
+                                       env_name: "GITLAB_API_ENDPOINT",
+                                       description: "API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :private_token,
+                                       env_name: "GITLAB_API_PRIVATE_TOKEN",
+                                       description: "user's private token or OAuth2 access token",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :version_name,
+                                       description: "The version name to generate the changelog",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CI_PROJECT_ID",
+                                       description: "The id of this project",
+                                       optional: true,
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                         case value
+                                         when String, Integer
+                                           @project_id = value
+                                         else
+                                           UI.user_error!("The project_id must be a String or Integer value.")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :include_mrs,
+                                       env_name: "GITLAB_RELEASE_INCLUDE_MRS",
+                                       description: "Should I include MRs in the changelog?",
+                                       optional: true,
+                                       type: Boolean,
+                                       default_value: true),
+          FastlaneCore::ConfigItem.new(key: :include_issues,
+                                       env_name: "GITLAB_RELEASE_INCLUDE_ISSUES",
+                                       description: "Should I include issues in the changelog?",
+                                       optional: true,
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :split_key,
+                                       env_name: "GITLAB_RELEASE_SPLIT_FINTERING_KEY",
+                                       description: "A split key for separate filtering labels",
+                                       optional: true,
+                                       type: String,
+                                       default_value: ","),
+          FastlaneCore::ConfigItem.new(key: :filtering_labels,
+                                       env_name: "GITLAB_RELEASE_FILTERING_LABELS",
+                                       description: "A general list of labels to filter items. You must separate labels with split key (default: ,)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :filtering_mrs_labels,
+                                       env_name: "GITLAB_RELEASE_FILTERING_MRS_LABELS",
+                                       description: "A specific list of labels to filter MRs. You must separate labels with split key (default: ,)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: ""),
+          FastlaneCore::ConfigItem.new(key: :filtering_issues_labels,
+                                       env_name: "GITLAB_RELEASE_FILTERING_ISSUES_LABELS",
+                                       description: "A specific list of labels to filter issues. You must separate labels with split key (default: ,)",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "")
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb

@@ -0,0 +1,97 @@
+require 'fastlane/action'
+require_relative '../helper/gitlab_release_helper'
+
+require 'gitlab/release/changelog/entries'
+
+module Fastlane
+  module Actions
+    class GitlabReleaseCloseAction < Action
+      def self.run(params)
+        require 'gitlab/release/manager'
+
+        endpoint = params[:endpoint] || ENV["GITLAB_API_ENDPOINT"] || ENV["CI_API_V4_URL"]
+        private_token = params[:private_token] || ENV["GITLAB_API_PRIVATE_TOKEN"]
+        version_name = params[:version_name]
+        entries = params[:entries]
+        tag_name = params[:tag_name] || version_name
+        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+        ref = params[:ref] || ENV["CI_COMMIT_SHA"]
+
+        manager = Gitlab::Release::Manager.new(endpoint, private_token)
+
+        UI.message("Closing all milestones related to version '#{version_name}'")
+        manager.close_milestones(version_name,
+                                 project_id: project_id)
+        UI.success("All milestones related to version '#{version_name}' are closed now!")
+
+        UI.message("Defining tag '#{tag_name}' in '#{ref}'")
+        manager.define_tag(tag_name,
+                           entries.to_s_with_reference(true),
+                           project_id: project_id,
+                           ref: ref)
+        UI.success("Defined tag '#{tag_name}' with changelog successfully!")
+      end
+
+      def self.description
+        "Create a tag with release note and close milestones"
+      end
+
+      def self.details
+        "This action create a tag containing release note and close the associated milestones"
+      end
+
+      def self.authors
+        ["Andrea Del Fante"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :endpoint,
+                                       env_name: "GITLAB_API_ENDPOINT",
+                                       description: "API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :private_token,
+                                       env_name: "GITLAB_API_PRIVATE_TOKEN",
+                                       description: "user's private token or OAuth2 access token",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :version_name,
+                                       description: "The version name to generate the changelog",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :entries,
+                                       description: "The generated changelog to include",
+                                       optional: false,
+                                       type: Gitlab::Release::Changelog::Entries),
+          FastlaneCore::ConfigItem.new(key: :tag_name,
+                                       description: "The tag name to use in the creating tag. Default: version_name",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CI_PROJECT_ID",
+                                       description: "The id of this project",
+                                       optional: true,
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                         case value
+                                         when String, Integer
+                                           @project_id = value
+                                         else
+                                           UI.user_error!("The project_id must be a String or Integer value.")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ref,
+                                       env_name: "CI_COMMIT_SHA",
+                                       description: "The ref to tag with tag_name. default: ENV['CI_COMMIT_SHA']",
+                                       optional: true,
+                                       type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/gitlab_release/helper/gitlab_release_helper.rb

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

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

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

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-gitlab_release
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Del Fante
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab-release-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+description: 
+email: andreadelfante94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/gitlab_release.rb
+- lib/fastlane/plugin/gitlab_release/actions/gitlab_release_changelog.rb
+- lib/fastlane/plugin/gitlab_release/actions/gitlab_release_close.rb
+- lib/fastlane/plugin/gitlab_release/helper/gitlab_release_helper.rb
+- lib/fastlane/plugin/gitlab_release/version.rb
+homepage: https://github.com/andreadelfante/fastlane-plugin-gitlab_release
+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.6
+signing_key: 
+specification_version: 4
+summary: Fastlane wrapper of gitlab-release-tools
+test_files: []