gitlab-release-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20787d80dd2afc4ea5def81e040bf317891a2bfb5821c720b6998b97d0b1fc45
+  data.tar.gz: f858b5b180f4669929d2abc1f29c866929f6ffebdfc3ace9d329dc86f8cffb90
+SHA512:
+  metadata.gz: 914e76075bd497179459a4358db51efc572d344ecf0e2ed2a62d2f41e88af04461a54eb76123f9bcc2ad150a8b45464fe938af340214a9ad6cdac90f4e0db574
+  data.tar.gz: ac452f8aee493b030cb8f642b55dba855c6714bd3c02e22d40354736d46f40dffbed8a4bb8065defa367758a58355332d959d8ab90f72316013468d6e94cd878

data/.env.example

@@ -0,0 +1,2 @@
+GITLAB_BASE_URL=http://gitlab.com/api/v4
+PRIVATE_TOKEN=<put your private token here>

data/.env.gitlab

@@ -0,0 +1,2 @@
+GITLAB_BASE_URL=http://gitlab.com/api/v4
+PRIVATE_TOKEN=ebjfSuxMXLuJhV_UuKbn

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.env
+/.env.spaggiari
+/.idea/

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build gitlab-release-tools-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install gitlab-release-tools-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install gitlab-release-tools-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push gitlab-release-tools-0.1.0.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6
+
+script:
+  - rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gitlab-release-tools.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    gitlab-release-tools (0.1.0)
+      gitlab (~> 4.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    gitlab (4.12.0)
+      httparty (~> 0.14, >= 0.14.0)
+      terminal-table (~> 1.5, >= 1.5.1)
+    hashdiff (1.0.0)
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    safe_yaml (1.0.5)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.6.0)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dotenv
+  gitlab-release-tools!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrea Del Fante
+
+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,36 @@
+# gitlab-release-tools
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab-release-tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlab-changelog-generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlab/changelog/generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gitlab-release-tools

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "gitlab/release/changelog/generator"
+require 'dotenv'
+
+Dotenv.load('../.env')
+
+endpoint = ENV["GITLAB_BASE_URL"]
+private_token = ENV["PRIVATE_TOKEN"]
+
+generator = Gitlab::Release::Changelog::Generator.new(endpoint, private_token)
+
+changelog = generator.changelog("1.1", project_id: 50)
+print(changelog)

data/gitlab-release-tools.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlab/release/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-release-tools"
+  spec.version       = Gitlab::Release::VERSION
+  spec.authors       = ["Andrea Del Fante"]
+  spec.email         = ["andreadelfante94@gmail.com"]
+
+  spec.summary       = "Automation gitlab release tools made simple."
+  spec.description   = "Automation gitlab release tools from MR and issues for your new versions."
+  spec.homepage      = "https://github.com/andreadelfante/gitlab-release-tools"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/andreadelfante/gitlab-release-tools"
+    #spec.metadata["changelog_uri"] = ""
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "gitlab", "~> 4.12.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency 'webmock'
+end

data/lib/gitlab/release/api_client.rb

@@ -0,0 +1,24 @@
+require 'gitlab'
+
+module Gitlab
+  module Release
+    class ApiClient
+      # @param [String] endpoint API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
+      # @param [String] private_token user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
+      def initialize(endpoint, private_token)
+        @client = Gitlab.client(
+            endpoint: endpoint,
+            private_token: private_token
+        )
+      end
+
+      # @param [String] version_name
+      # @return Array
+      protected def select_milestones(project_id, version_name)
+        @client.milestones(project_id).select do |milestone|
+          milestone.title.include?(version_name) || milestone.description.include?(version_name)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/release/changelog/entries.rb

@@ -0,0 +1,34 @@
+module Gitlab
+  module Release
+    module Changelog
+      class Entries
+        def initialize
+          # @type [Array] elements
+          @elements = []
+        end
+
+        # @param [Entry] element
+        def push(element)
+          @elements.push(element)
+        end
+
+        def to_s
+          @elements.map { |element| element.to_s }
+              .join("\n")
+              #.reject(&:empty?)
+        end
+
+        # @param [String] path
+        # @param [TrueClass or FalseClass] appending default false
+        def write_on_file(path, appending = false)
+          # @type [String] changelog_string
+          changelog_string = to_s
+
+          File.open(path, appending ? "a" : "w+") do |file|
+            file.puts(changelog_string)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/release/changelog/entry.rb

@@ -0,0 +1,32 @@
+module Gitlab
+  module Release
+    module Changelog
+      class Entry
+        attr_reader :title, :id
+
+        # @param [Integer] id
+        # @param [String] title
+        def initialize(id, title)
+          @id = id
+          @title = title
+        end
+
+        def to_s
+          "[#{@id}] #{@title}"
+        end
+      end
+
+      class MergeRequest < Entry
+        def to_s
+          "- #{title} !#{id}"
+        end
+      end
+
+      class Issue < Entry
+        def to_s
+          "- #{title} ##{id}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/release/changelog/generator.rb

@@ -0,0 +1,117 @@
+require 'gitlab/release/api_client'
+require 'gitlab/release/changelog/entries'
+require 'gitlab/release/changelog/entry'
+require 'gitlab/release/version'
+
+module Gitlab
+  module Release
+    module Changelog
+      class Generator < ApiClient
+        # @param [String] endpoint API endpoint URL, default: ENV['GITLAB_API_ENDPOINT'] and falls back to ENV['CI_API_V4_URL']
+        # @param [String] private_token user's private token or OAuth2 access token, default: ENV['GITLAB_API_PRIVATE_TOKEN']
+        # @param [Integer] max_loop_mrs
+        # @param [Integer] max_loop_issues
+        def initialize(endpoint, private_token, max_loop_mrs = 1000, max_loop_issues = 1000)
+          @max_loops_merge_requests = max_loop_mrs
+          @max_loop_issues = max_loop_issues
+          super(endpoint, private_token)
+        end
+
+        # @param [String] version_name required
+        # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
+        # @param [TrueClass or FalseClass] include_mrs default true
+        # @param [TrueClass or FalseClass] include_issues default false
+        # @param [Array[String]] filtering_labels default []
+        # @param [Array[String]] filtering_mrs_labels default []
+        # @param [Array[String]] filtering_issues_labels default []
+        # @return [Entries]
+        def changelog(version_name, params = {})
+          project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+          include_mrs = params[:include_mrs] || true
+          include_issues = params[:include_issues] || false
+          filtering_mrs_labels = params[:filtering_mrs_labels] || params[:filtering_labels] || []
+          filtering_issue_labels = params[:filtering_issues_labels] || params[:filtering_labels] || []
+
+          entries = Entries.new
+          if include_mrs
+            changelog_from_merge_requests(entries,
+                                          project_id,
+                                          version_name,
+                                          filtering_mrs_labels)
+          end
+          if include_issues
+            changelog_from_issues(entries,
+                                  project_id,
+                                  version_name,
+                                  filtering_issue_labels)
+          end
+          entries
+        end
+
+        # @param [Entries] entries
+        # @param [String or Integer] project_id
+        # @param [String] version_name
+        # @param Array[String] filtering_labels
+        private def changelog_from_merge_requests(entries, project_id, version_name, filtering_labels)
+          select_milestones(project_id, version_name).each do |milestone|
+            i = 1
+            all = false
+
+            while i < @max_loops_merge_requests and !all
+              merge_requests = @client.milestone_merge_requests(project_id, milestone.id, {page: i})
+              all = merge_requests.empty?
+
+              merge_requests.each do |mr|
+                if check_mr(mr, filtering_labels)
+                  entries.push(MergeRequest.new(mr.iid, mr.title))
+                end
+              end
+
+              i += 1
+            end
+          end
+        end
+
+        # @param [Gitlab::ObjectifiedHash] mr
+        # @param [Array[String]] filtering_labels
+        # @return [TrueClass or FalseClass]
+        private def check_mr(mr, filtering_labels)
+          mr.state == 'merged' and (filtering_labels - mr.labels).empty?
+        end
+
+        # @param [Entries] entries
+        # @param [String or Integer] project_id
+        # @param [String] version_name
+        # @param [TrueClass or FalseClass] only_closed
+        # @param Array[String] filtering_labels
+        private def changelog_from_issues(entries, project_id, version_name, filtering_labels)
+          select_milestones(project_id, version_name).each do |milestone|
+            i = 1
+            all = false
+
+            while i < @max_loop_issues and !all
+              issues = @client.milestone_issues(project_id, milestone.id, {page: i})
+              all = issues.empty?
+
+              issues.each do |issue|
+                if check_issue(issue, filtering_labels)
+                  entries.push(Issue.new(issue.id, issue.title))
+                end
+              end
+
+              i += 1
+            end
+          end
+        end
+
+        # @param [Gitlab::ObjectifiedHash] issue
+        # @param [Array[String]] filtering_labels
+        # @return [TrueClass or FalseClass]
+        private def check_issue(issue, filtering_labels)
+          issue.state == 'closed' and (filtering_labels - issue.labels).empty?
+        end
+      end
+    end
+  end
+end
+

data/lib/gitlab/release/manager.rb

@@ -0,0 +1,28 @@
+require 'gitlab/release/api_client'
+
+module Gitlab
+  module Release
+    class Manager < ApiClient
+      # @param [String] tag_name
+      # @param [String] changelog
+      # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
+      # @param [String] ref default ENV["CI_COMMIT_SHA"]
+      def define_tag(tag_name, changelog, params = {})
+        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+        ref = params[:ref] || ENV["CI_COMMIT_SHA"]
+
+        @client.create_tag(project_id, tag_name, ref, '', changelog)
+      end
+
+      # @param [String] version_name
+      # @param [String or Integer] project_id default ENV["CI_PROJECT_ID"]
+      def close_milestones(version_name, params = {})
+        project_id = params[:project_id] || ENV["CI_PROJECT_ID"]
+
+        select_milestones(project_id, version_name).each do |milestone|
+          @client.edit_milestone(project_id, milestone.id, state_event: 'close')
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/release/version.rb

@@ -0,0 +1,5 @@
+module Gitlab
+  module Release
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-release-tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Del Fante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Automation gitlab release tools from MR and issues for your new versions.
+email:
+- andreadelfante94@gmail.com
+executables:
+- gitlab-release-tools
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".env.gitlab"
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitlab-release-tools
+- gitlab-release-tools.gemspec
+- lib/gitlab/release/api_client.rb
+- lib/gitlab/release/changelog/entries.rb
+- lib/gitlab/release/changelog/entry.rb
+- lib/gitlab/release/changelog/generator.rb
+- lib/gitlab/release/manager.rb
+- lib/gitlab/release/version.rb
+homepage: https://github.com/andreadelfante/gitlab-release-tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andreadelfante/gitlab-release-tools
+  source_code_uri: https://github.com/andreadelfante/gitlab-release-tools
+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: Automation gitlab release tools made simple.
+test_files: []