gitlab_awesome_release 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8216d0fc231295e49843e172a98823956739932b4e1c9234a47c10c41d6d73
-  data.tar.gz: 44d3f967e2acb74643e7dabdcaaf94308b7446f954954050281b8c51cdf0a3bd
+  metadata.gz: e6119d125dfe22d2498b05ac8239fedd1faea8308a6f7608d1c5e2d658aaacbb
+  data.tar.gz: 67f2eb14cf37f406cf8639a62982cb21fc5fc030b35303c5ce592874a4ddbb72
 SHA512:
-  metadata.gz: d71835b0b185a3b3003c0c2f185a3067c7bdf07f3a3c390046430c4fd1c5387154254e1b27bbaf6def8de879c9db1348cf7ade8d302b316e43be428893498cbc
-  data.tar.gz: 9f7c6371fcd757fa9ccfc4353a81c69abd3cced58acc681a0f78f1dbe4e7d88f61ff7e6dde2666446f12f4cf38fa92afb00363d6b45bd8ccab5b1863b9ee6bda
+  metadata.gz: cb463789ea8b4495ea08e9906b78c2b3c179c40a59ec958049d8d475cd8039e02a2a601be64adbebbd7ded9143ecf3b4eea5208c43ac5107f76b404fe9bf4c9d
+  data.tar.gz: bee53477925536e2fa9994a15dd5009c0dd90397b96f4b3abb50159692b5d87d6abe88e46a9706e2838b2042ee4b4baaf4a39f68fbddb0a491a5ede2eb92443d

data/.gitlab-ci.yml

@@ -23,11 +23,16 @@ test:
 
   script:
     - bundle exec rspec
-    - bundle exec rubocop -P
+
+  coverage: '/LOC \(([\d.]+)%\) covered/'
+
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/coverage.xml
 
   rules:
-    - if: '$IMAGE == "rubylang/ruby:master-nightly-bionic"'
-      allow_failure: true
     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
@@ -42,7 +47,9 @@ test:
           - ruby:2.6
           - ruby:2.7
           - ruby:3.0
-          - rubylang/ruby:master-nightly-bionic
+          - ruby:3.1
+          - ruby:3.2
+          - ruby:3.3
 
 pages:
   extends: .default

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
-[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v1.0.4...master)
+[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v1.1.0...master)
+
+## v1.1.0
+[full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v1.0.4...v1.1.0)
+
+* Allow specifying M-R commit format for changelog generation
+  * https://gitlab.com/sue445/gitlab_awesome_release/-/merge_requests/57
 
 ## v1.0.4
 [full changelog](https://gitlab.com/sue445/gitlab_awesome_release/compare/v1.0.3...v1.0.4)

data/Gemfile

@@ -3,7 +3,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in gitlab_awesome_release.gemspec
 gemspec
 
-# rubocop:disable Bundler/DuplicatedGem
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.0")
+  group :development do
+    # NOTE: addressable 2.8.1+ requires ruby 2.2.0+
+    gem "addressable", "< 2.8.1"
+  end
+end
+
 if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.3.0")
   group :development do
     # NOTE: gitlab 4.6.0+ requires ruby 2.3.0+
@@ -14,6 +20,12 @@ if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.3.0")
 
     # NOTE: httparty 0.20.0+ requires ruby 2.3.0+
     gem "httparty", "< 0.20.0"
+
+    # NOTE: webrick 1.4.0+ requires ruby 2.3.0+
+    gem "webrick", "< 1.4.0"
+
+    # NOTE: webmock 3.17.0+ requires ruby 2.3.0+
+    gem "webmock", "< 3.17.0"
   end
 elsif Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.4.0")
   group :development do
@@ -34,12 +46,14 @@ elsif Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.4.0")
     gem "parallel", "< 1.20.1"
   end
 end
-# rubocop:enable Bundler/DuplicatedGem
 
 if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.5.0")
   group :development do
     # NOTE: docile 1.4.0+ requires ruby 2.5.0+
     gem "docile", "< 1.4.0"
+
+    # NOTE: simplecov-cobertura 2.0.0+ requires ruby 2.5.0+
+    gem "simplecov-cobertura", "< 2.0.0"
   end
 end
 
@@ -47,6 +61,9 @@ if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.4.0")
   group :development do
     # NOTE: simplecov-html 0.11.0+ requires ruby 2.4.0+
     gem "simplecov-html", "< 0.11.0"
+
+    # NOTE: unicode-display_width 2.4.0+ requires ruby 2.4.0+
+    gem "unicode-display_width", "< 2.4.0"
   end
 end
 

data/README.md

@@ -1,5 +1,7 @@
 # GitlabAwesomeRelease
-Generate changelog from tags and MergeRequests on [GitLab](https://about.gitlab.com/)
+Generate changelog from tags and MergeRequests on [GitLab™](https://about.gitlab.com/)
+
+_GITLAB is a trademark of GitLab Inc. in the United States and other countries and regions_
 
 [![Gem Version](https://badge.fury.io/rb/gitlab_awesome_release.svg)](https://badge.fury.io/rb/gitlab_awesome_release)
 [![pipeline status](https://gitlab.com/sue445/gitlab_awesome_release/badges/master/pipeline.svg)](https://gitlab.com/sue445/gitlab_awesome_release/commits/master)
@@ -60,8 +62,11 @@ All options can be specified in both the command arguments and environment varia
   * Filepath to changelog file (e.g. `CHANGELOG.md`)
   * if empty, output to console
 * `--allow-tag-format` , `ALLOW_TAG_FORMAT`
-  * Tag format for release note heading (regular expresion pattern)
+  * Tag format for release note heading (regular expression pattern)
   * default: `^v?[\d.]+`
+* `--merge-request-commit-format` , `MERGE_REQUEST_COMMIT_FORMAT`
+  * Commit format for matching merge request (regular expression pattern)
+  * default: `^Merge branch .*See merge request .*\!(\d+)$`
 * `--log-level` , `LOG_LEVEL`
   * Log level `(debug|info|warn|error|fatal|unknown)`
   * default: `info`
@@ -86,8 +91,11 @@ All options can be specified in both the command arguments and environment varia
   * Filepath to changelog file (e.g. `CHANGELOG.md`)
   * if empty, output to console
 * `--allow-tag-format` , `ALLOW_TAG_FORMAT`
-  * Tag format for release note heading (regular expresion pattern)
+  * Tag format for release note heading (regular expression pattern)
   * default: `^v?[\d.]+`
+* `--merge-request-commit-format` , `MERGE_REQUEST_COMMIT_FORMAT`
+  * Commit format for matching merge request (regular expression pattern)
+  * default: `^Merge branch .*See merge request .*\!(\d+)$`
 * `--log-level` , `LOG_LEVEL`
   * Log level `(debug|info|warn|error|fatal|unknown)`
   * default: `info`

data/gitlab_awesome_release.gemspec

@@ -30,12 +30,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler", ">= 1.10"
-  spec.add_development_dependency "onkcop", "0.53.0.2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-temp_dir"
-  spec.add_development_dependency "rubocop", "0.57.2" # rubocop v0.58.0+ requires ruby 2.2+
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-cobertura"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "yard"
 end

data/lib/gitlab_awesome_release/cli.rb

@@ -7,6 +7,7 @@ module GitlabAwesomeRelease
 
   class CLI < Thor
     DEFAULT_VERSION_FORMAT = "^v?[\\d.]+".freeze
+    DEFAULT_MERGE_REQUEST_COMMIT_FORMAT = "^Merge branch .*See merge request .*\!(\d+)$".freeze
     GITLAB_ENV_FILES = %w[.env.gitlab ~/.env.gitlab].freeze
 
     GITLAB_API_DESCRIPTION               = "GitLab API endpoint (e.g. http://example.com/api/v4)".freeze
@@ -20,14 +21,15 @@ module GitlabAwesomeRelease
     end
 
     desc "create_note", "generate changelog"
-    option :gitlab_api_endpoint,      desc: GITLAB_API_DESCRIPTION
-    option :gitlab_api_private_token, desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
-    option :gitlab_project_name,      desc: GITLAB_API_PROJECT_NAME
-    option :from_tag,                 desc: "The first tag to create a changelog (default: oldest tag)"
-    option :to_tag,                   desc: "The last tag to create a changelog (default: latest tag)"
-    option :filename,                 desc: "Filepath to changelog file (e.g. CHANGELOG.md). if empty, output to console"
-    option :allow_tag_format,         desc: "Tag format for release note heading (regular expresion pattern)", default: DEFAULT_VERSION_FORMAT
-    option :log_level,                desc: LOG_LEVEL_DESCRIPTION, default: "info"
+    option :gitlab_api_endpoint,          desc: GITLAB_API_DESCRIPTION
+    option :gitlab_api_private_token,     desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
+    option :gitlab_project_name,          desc: GITLAB_API_PROJECT_NAME
+    option :from_tag,                     desc: "The first tag to create a changelog (default: oldest tag)"
+    option :to_tag,                       desc: "The last tag to create a changelog (default: latest tag)"
+    option :filename,                     desc: "Filepath to changelog file (e.g. CHANGELOG.md). if empty, output to console"
+    option :allow_tag_format,             desc: "Tag format for release note heading (regular expression pattern)", default: DEFAULT_VERSION_FORMAT
+    option :merge_request_commit_format,  desc: "Commit format for matching merge request (regular expression pattern)", default: DEFAULT_MERGE_REQUEST_COMMIT_FORMAT
+    option :log_level,                    desc: LOG_LEVEL_DESCRIPTION, default: "info"
     def create_note
       Dotenv.load(*GITLAB_ENV_FILES)
 
@@ -44,12 +46,13 @@ module GitlabAwesomeRelease
     end
 
     desc "create_latest_note", "generate release note only latest version and unreleased"
-    option :gitlab_api_endpoint,      desc: GITLAB_API_DESCRIPTION
-    option :gitlab_api_private_token, desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
-    option :gitlab_project_name,      desc: GITLAB_API_PROJECT_NAME
-    option :filename,                 desc: "Filepath to changelog file (e.g. CHANGELOG.md). if empty, output to console"
-    option :allow_tag_format,         desc: "Tag format for release note heading (regular expresion pattern)", default: DEFAULT_VERSION_FORMAT
-    option :log_level,                desc: LOG_LEVEL_DESCRIPTION, default: "info"
+    option :gitlab_api_endpoint,          desc: GITLAB_API_DESCRIPTION
+    option :gitlab_api_private_token,     desc: GITLAB_API_PRIVATE_TOKEN_DESCRIPTION
+    option :gitlab_project_name,          desc: GITLAB_API_PROJECT_NAME
+    option :filename,                     desc: "Filepath to changelog file (e.g. CHANGELOG.md). if empty, output to console"
+    option :allow_tag_format,             desc: "Tag format for release note heading (regular expression pattern)", default: DEFAULT_VERSION_FORMAT
+    option :merge_request_commit_format,  desc: "Commit format for matching merge request (regular expression pattern)", default: DEFAULT_MERGE_REQUEST_COMMIT_FORMAT
+    option :log_level,                    desc: LOG_LEVEL_DESCRIPTION, default: "info"
     def create_latest_note
       Dotenv.load(*GITLAB_ENV_FILES)
 
@@ -111,10 +114,11 @@ module GitlabAwesomeRelease
       end
 
       def create_project
-        gitlab_api_endpoint      = option_or_env!(:gitlab_api_endpoint)
-        gitlab_api_private_token = option_or_env!(:gitlab_api_private_token)
-        gitlab_project_name      = option_or_env!(:gitlab_project_name)
-        allow_tag_format         = option_or_env(:allow_tag_format, DEFAULT_VERSION_FORMAT)
+        gitlab_api_endpoint         = option_or_env!(:gitlab_api_endpoint)
+        gitlab_api_private_token    = option_or_env!(:gitlab_api_private_token)
+        gitlab_project_name         = option_or_env!(:gitlab_project_name)
+        allow_tag_format            = option_or_env(:allow_tag_format, DEFAULT_VERSION_FORMAT)
+        merge_request_commit_format = option_or_env(:merge_request_commit_format, DEFAULT_MERGE_REQUEST_COMMIT_FORMAT)
 
         @logger = Logger.new(STDOUT)
         @logger.level = logger_level(option_or_env(:log_level))
@@ -128,6 +132,7 @@ module GitlabAwesomeRelease
           private_token:    gitlab_api_private_token,
           project_name:     gitlab_project_name,
           allow_tag_format: /#{allow_tag_format}/,
+          merge_request_commit_format: /#{merge_request_commit_format}/m,
           logger:           @logger,
         )
       end

data/lib/gitlab_awesome_release/project.rb

@@ -11,13 +11,15 @@ module GitlabAwesomeRelease
     # @param private_token    [String]
     # @param project_name     [String]
     # @param allow_tag_format [Regexp]
-    def initialize(api_endpoint:, private_token:, project_name:, allow_tag_format:, logger:)
+    # @param merge_request_commit_format [Regexp]
+    def initialize(api_endpoint:, private_token:, project_name:, allow_tag_format:, merge_request_commit_format:, logger:)
       Gitlab.configure do |config|
         config.endpoint      = api_endpoint
         config.private_token = private_token
       end
       @project_name = project_name
       @allow_tag_format = allow_tag_format
+      @merge_request_commit_format = merge_request_commit_format
       @logger = logger
     end
 
@@ -36,10 +38,9 @@ module GitlabAwesomeRelease
           Gitlab.repo_tags(@project_name, params)
         end
 
-      # rubocop:disable Style/SymbolProc avoid SEGV on ruby 2.6.0
+      # avoid SEGV on ruby 2.6.0
       # https://bugs.ruby-lang.org/issues/15489
       @all_tag_names = repo_tags.sort_by {|tag| tag.commit.authored_date }.map {|tag| tag.name }
-      # rubocop:enable Style/SymbolProc
     end
 
     # @return [Array<String>]
@@ -104,7 +105,7 @@ module GitlabAwesomeRelease
 
       merge_request_iids =
         commits.map do |commit|
-          commit["message"] =~ /^Merge branch .*See merge request .*\!(\d+)$/m
+          commit["message"] =~ @merge_request_commit_format
           Regexp.last_match(1)
         end
 
@@ -139,7 +140,7 @@ module GitlabAwesomeRelease
       mr_iids.each_with_object("") do |iid, str|
         begin
           str << merge_request_summary(iid) + "\n"
-        rescue Gitlab::Error::NotFound # rubocop:disable Lint/HandleExceptions
+        rescue Gitlab::Error::NotFound
           # NOTE: suppress error (e.g. other repo's iid)
         end
       end

data/lib/gitlab_awesome_release/version.rb

@@ -1,3 +1,3 @@
 module GitlabAwesomeRelease
-  VERSION = "1.0.4".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_awesome_release
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -66,32 +66,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: onkcop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.53.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.53.0.2
 - !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
@@ -123,21 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -190,7 +176,6 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
-- ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -232,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Generate changelog from tags and MergeRequests on GitLab

data/.rubocop.yml

@@ -1,20 +0,0 @@
-inherit_gem:
-  onkcop: "config/rubocop.yml"
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
-Layout/AlignHash:
-  EnforcedColonStyle: table
-
-Layout/ClosingHeredocIndentation:
-  Enabled: false
-
-Layout/IndentHeredoc:
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 130