gitlab-triage 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2282112f85b0f8af0edd3fd6c553848768e15c2b39402b1e9344564626086a9c
-  data.tar.gz: 55f84c356fd84e7cd35aea63d2f6c377a96a82b13f23322dece9d9eb077c7f98
+  metadata.gz: 151d7ca8651d7f913171ef8fe50a1128d2101df9286d88cffe57cbc20d50f254
+  data.tar.gz: 81a9fab0da6480444ad0498a361c364efac00c63c3db56b3d26b433a6f83f388
 SHA512:
-  metadata.gz: 0c5989be48592d0f1d6110c2e0f752bcb3a492a20027845829a3b97c21b421d61548007f443f01e7b85c5136f47b081909b2f4470a7f142d4de7ec4abc4f121a
-  data.tar.gz: 994b0b296c5382f2c402b4a42c9ffac7678777051b8dd6ba28bd6e30360f297139d2ab8ec88edbf26ef919b436303ce62bdd0fddddb9358e35177aceb59971e4
+  metadata.gz: fa57bcfddb6a36c963cd1bd80903deef7c03d82bc77e259d5d71d9edc01dcf9b7786d0b88b79110273c7167fc6b74339da904470c79d648b8ed50ebd1b2ceb88
+  data.tar.gz: 92929ba6651a46241581dac4d3a3ec902e959ecea660b51cb7a861dba32f9418a760d9bcaaedf645439e39e6bdd5462880d9b1c635a90d3a9cf6499d372d43e8

data/.gitlab-ci.yml

@@ -82,7 +82,7 @@ dry-run:gitlab-triage:
     - bundle exec rake install:local
     - gitlab-triage --help
     - gitlab-triage --init
-    - gitlab-triage --dry-run --debug --token $API_TOKEN --project-id $CI_PROJECT_PATH
+    - gitlab-triage --dry-run --debug --token $API_TOKEN --source-id $CI_PROJECT_PATH
 
 dry-run:gitlab-ce:
   <<: *pull-cache
@@ -90,5 +90,5 @@ dry-run:gitlab-ce:
   script:
     - bundle exec rake install:local
     - gitlab-triage --help
-    - gitlab-triage --dry-run --debug --token $API_TOKEN --project-id gitlab-org/gitlab-ce
+    - gitlab-triage --dry-run --debug --token $API_TOKEN --source-id gitlab-org/gitlab-ce
   when: manual

data/README.md

@@ -9,8 +9,11 @@ This project contains the library and pipeline definition to enable automated tr
 ### Abstract
 
 The `gitlab-triage` gem aims to enable project managers and maintainers to
-automatically triage Issues and Merge Requests in GitLab projects based on
-defined policies.
+automatically triage Issues and Merge Requests in GitLab projects or groups
+based on defined policies.
+
+See [Running locally](#running-locally) for how to specify a project or a
+group.
 
 ### What is a triage policy?
 
@@ -258,6 +261,10 @@ resource_rules:
             - Quality
 ```
 
+> Note:
+>   If you want to define a full label expansion, you'll need to [force string](https://yaml.org/YAML_for_ruby.html#forcing_strings) or [quote string](https://yaml.org/YAML_for_ruby.html#single-quoted_strings) because otherwise it won't be considered a string due to the YAML parser.
+>   For example, we can quote the expression like `'{ apple, orange }'`, which will create 2 rules, for the two specified labels.
+
 ###### Sequence
 
 The name of a label can contain one or more sequence conditions, written
@@ -832,14 +839,24 @@ Here's a list of currently available Ruby expression API:
 | version_short | String      | The short string of version. e.g. `11.3` |
 | revision      | String      | The revision of GitLab. e.g. `231b0c7` |
 
+### Installation
+
+    gem install gitlab-triage
+
 ### Usage
 
+    gitlab-triage --help
+
+Will show:
+
 ```
 Usage: gitlab-triage [options]
 
     -n, --dry-run                    Don't actually update anything, just print
     -f, --policies-file [string]     A valid policies YML file
-    -p, --project-id [string]        A project ID or path
+    -s, --source [type]              The source type between [ projects or groups ], default value: projects
+    -i, --source-id [string]         Source ID or path
+    -p, --project-id [string]        [Deprecated] A project ID or path, please use `--source-id`
     -t, --token [string]             A valid API token
     -H, --host-url [string]          A valid host url
     -d, --debug                      Print debug information
@@ -848,15 +865,21 @@ Usage: gitlab-triage [options]
         --init-ci                    Initialize the project with a .gitlab-ci.yml file
 ```
 
-#### Local
+#### Running locally
+
+Triaging against a specific project:
+
+```
+gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org/triage
+```
+
+Triaging against a whole group:
 
 ```
-gem install gitlab-triage
-gitlab-triage --help
-gitlab-triage --dry-run --token $API_TOKEN --project-id gitlab-org/triage
+gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org --source groups
 ```
 
-#### GitLab CI pipeline
+#### Running on GitLab CI pipeline
 
 You can enforce policies using a scheduled pipeline:
 
@@ -865,7 +888,7 @@ run:triage:triage:
   stage: triage
   script:
     - gem install gitlab-triage
-    - gitlab-triage --token $API_TOKEN --project-id $CI_PROJECT_PATH
+    - gitlab-triage --token $API_TOKEN --source-id $CI_PROJECT_PATH
   only:
     - schedules
 ```
@@ -879,7 +902,7 @@ Yes, you can override the host url using the following options:
 ##### CLI
 
 ```
-gitlab-triage --dry-run --token $API_TOKEN --project-id gitlab-org/triage --host-url https://gitlab.host.com
+gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org/triage --host-url https://gitlab.host.com
 ```
 
 ##### Policy file

data/gitlab-triage.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '~> 5.1'
   spec.add_dependency 'httparty', '~> 0.15'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'gitlab-styles', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/gitlab/triage/action/comment.rb

@@ -58,7 +58,7 @@ module Gitlab
           # POST /projects/:id/issues/:issue_iid/notes
           post_url = UrlBuilders::UrlBuilder.new(
             network_options: network.options,
-            source_id: network.options.project_id,
+            source_id: resource[:project_id],
             resource_type: policy.type,
             resource_id: resource['iid'],
             sub_resource_type: 'notes'

data/lib/gitlab/triage/action/summarize.rb

@@ -37,7 +37,7 @@ module Gitlab
           # https://docs.gitlab.com/ee/api/issues.html#new-issue
           post_url = UrlBuilders::UrlBuilder.new(
             network_options: network.options,
-            source_id: network.options.project_id,
+            source_id: network.options.source_id,
             resource_type: 'issues'
           ).build
 

data/lib/gitlab/triage/engine.rb

@@ -1,4 +1,5 @@
 require 'active_support/all'
+require 'active_support/inflector'
 
 require_relative 'expand_condition'
 require_relative 'filters/date_conditions_filter'
@@ -41,7 +42,7 @@ module Gitlab
       def perform
         puts "Performing a dry run.\n\n" if options.dry_run
 
-        puts Gitlab::Triage::UI.header("Triaging the `#{options.project_id}` project", char: '=')
+        puts Gitlab::Triage::UI.header("Triaging the `#{options.source_id}` #{options.source.to_s.singularize}", char: '=')
         puts
 
         resource_rules.each do |resource_type, resource|
@@ -60,9 +61,9 @@ module Gitlab
       private
 
       def assert_project_id!
-        return if options.project_id
+        return if options.source_id
 
-        raise ArgumentError, 'A project_id is needed (pass it with the `--project-id` option)!'
+        raise ArgumentError, 'A project_id is needed (pass it with the `--source-id` option)!'
       end
 
       def assert_token!
@@ -198,7 +199,8 @@ module Gitlab
 
         UrlBuilders::UrlBuilder.new(
           network_options: options,
-          source_id: options.project_id,
+          source: options.source,
+          source_id: options.source_id,
           resource_type: resource_type,
           params: params
         ).build

data/lib/gitlab/triage/option_parser.rb

@@ -24,8 +24,19 @@ module Gitlab
               options.policies_file = value
             end
 
-            opts.on('-p', '--project-id [string]', String, 'A project ID or path') do |value|
-              options.project_id = value
+            opts.on('-s', '--source [type]', [:projects, :groups], 'The source type between [ projects or groups ], default value: projects') do |value|
+              options.source = value
+            end
+
+            opts.on('-i', '--source-id [string]', String, 'Source ID or path') do |value|
+              options.source_id = value
+            end
+
+            opts.on('-p', '--project-id [string]', String, '[Deprecated] A project ID or path, please use `--source-id`') do |value|
+              puts Gitlab::Triage::UI.warn("The option `--project-id` has been deprecated, please use `--source-id` instead")
+              puts
+              options.source = 'projects'
+              options.source_id = value
             end
 
             opts.on('-t', '--token [string]', String, 'A valid API token') do |value|

data/lib/gitlab/triage/options.rb

@@ -3,7 +3,8 @@ module Gitlab
     Options = Struct.new(
       :dry_run,
       :policies_file,
-      :project_id,
+      :source,
+      :source_id,
       :token,
       :debug,
       :host_url,
@@ -15,6 +16,7 @@ module Gitlab
         # Defaults
         self.host_url ||= 'https://gitlab.com'
         self.api_version ||= 'v4'
+        self.source ||= 'projects'
       end
     end
   end

data/lib/gitlab/triage/ui.rb

@@ -10,6 +10,10 @@ module Gitlab
       def self.debug(text)
         "[DEBUG] #{text}"
       end
+
+      def self.warn(text)
+        "[WARNING] #{text}"
+      end
     end
   end
 end

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '0.15.0'.freeze
+    VERSION = '0.16.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gitlab-styles
   requirement: !ruby/object:Gem::Requirement