gitlab-triage 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e60f60430321d0d1be1393d07613ce3e2173cdb45552a530783f797e5b8fe830
-  data.tar.gz: 96166faf93db799035226e0cb052bb56b50bbfb95df74c074b944b3b61a1557e
+  metadata.gz: d82746964d894d23cf152a4a5fb996e23216355bba6aa639cb6ea339dcf6fd13
+  data.tar.gz: cc931bd1c1e8f4097e3463b4351f426e39b69cbdbb9dc2e4ac7dafd426659de7
 SHA512:
-  metadata.gz: e6ba81eb4674a0b436b9f31079f1aa557c95b454eb1378ab9c18994ac53faf9cc51e213393c404622cf45131f06da883c7b3940bc4009dc0c1f45b564faf7fa5
-  data.tar.gz: 2eefc9bf80feb415a9d820009d6f58b78698be4e426247ec50356289fa8bbe668de7da03057506a0bdc35809bb99956fa868b2aae535cbafa97671575ae84ab6
+  metadata.gz: 25effb45c3c03772ade06f3c8fee5b69598917a541aaece754fe053fc77f4bf92d8e74739d9cc3fe605ec275df73cc1c2110615b43d8ee0c57cf2fd3db2e8b3e
+  data.tar.gz: 7c40513edecbed3ab28f9fd116fc554bd6a4fc9dfc828d461a2bccfa4d166aa0960385a1865c487c88172f348a62c19e9a0a197b626aba5e8c8ef1ba5bf6109c

data/.triage-policies.yml

@@ -18,7 +18,7 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            Hi,
+            Hi {{author}},
 
             First of all, thank you for raising an issue to help improve the GitLab product. We're sorry about this, but this particular issue has gone unnoticed for quite some time. To establish order in the GitLab-CE Issue Tracker, we must ensure that every issue is correctly labelled and triaged, to get the proper attention.
 
@@ -50,7 +50,7 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            Hi,
+            Hi {{author}},
 
             First of all, thank you for raising an issue to help improve the GitLab product. We're sorry about this, but this particular issue has gone unnoticed for quite some time. To establish order in the GitLab-CE Issue Tracker, we must ensure that every issue is correctly labelled and triaged, to get the proper attention.
 
@@ -83,7 +83,7 @@ resource_rules:
             - markglenfletcher
           status: close
           comment: |
-            Closing this issue down in accordance with our [Issue Triage Policies](https://gitlab.com/gitlab-org/triage). Please reopen the issue if you feel that the issue is still relevant. Thanks!
+            {{author}} Closing this issue down in accordance with our [Issue Triage Policies](https://gitlab.com/gitlab-org/triage). Please reopen the issue if you feel that the issue is still relevant. Thanks!
       - name: Mark potentially interesting feature proposals
         conditions:
           labels:
@@ -122,15 +122,15 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            Hi,
+            Hi {{author}},
 
             First of all, thank you for raising an issue to help improve the GitLab product. This issue was labelled as a ~"feature proposal" in the past. In order to maintain order in the issue tracker, we are starting to close off old, unpopular feature proposals that have not gained many votes since opening.
 
             This issue will be closed, as it meets the following criteria:
-            * No activity in the past 12 months
-            * Labelled as a ~"feature proposal"
+            * No activity in the past 12 months (last update was {{updated_at}})
+            * Current labels ({{labels}}) include ~"feature proposal"
             * Unscheduled (not associated with a milestone)
-            * Less than 10 upvotes
+            * Less than 10 upvotes (currently {{upvotes}} upvotes)
 
             Thanks for your help and please raise any new feature proposals as a new issue.
       - name: Mark very popular, unscheduled feature proposals
@@ -167,14 +167,14 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            Hi,
+            Hi {{author}},
 
             First of all, thank you for raising an issue to help improve the GitLab product. We're sorry about this, but this particular issue has gone unnoticed for quite some time. To establish order in the GitLab-CE Issue Tracker, we must ensure that every issue is correctly labelled and triaged, to get the proper attention.
 
             This issue will be marked for closure, as it meets the following criteria:
             * Issue is open
-            * No activity in the past 6 months
-            * Labelled as a bug
+            * No activity in the past 6 months (last update was {{updated_at}})
+            * Current labels ({{labels}}) include ~bug
             * Unscheduled (no milestone)
 
             We'd like to ask you to help us out and determine whether this issue should be reopened.
@@ -201,14 +201,14 @@ resource_rules:
           mention:
             - rymai
           comment: |
-            Hi,
+            Hi {{author}},
 
-            First of all, thank you for creating a Merge Request to help improve the GitLab product. We are running through old Merge Requests and asking authors to update their Merge Requests 
+            First of all, thank you for creating a Merge Request to help improve the GitLab product. We are running through old Merge Requests and asking authors to update their Merge Requests
 
             This Merge Request was chosen, as it meets the following criteria:
             * Open
-            * Labelled ~"Community Contribution"
-            * No activity in the past 6 months
+            * No activity in the past 6 months (last update was {{updated_at}})
+            * Current labels ({{labels}}) include ~"Community Contribution"
 
             We'd like to ask you to help us out and let us know whether:
             * You would like to continue the work here

data/README.md

@@ -52,7 +52,7 @@ resource_rules:
           mention:
             - markglenfletcher
           comment: |
-            This issue is unlabelled after 5 days. It needs attention.
+            {{author}} This issue is unlabelled after 5 days. It needs attention.
   merge_requests:
     rules:
       []
@@ -329,9 +329,30 @@ actions:
 
 Adds a comment to the resource.
 
-Accepts a string.
+Accepts a string, and placeholders. Placeholders should be wrapped in double
+curly braces, e.g. `{{author}}`.
 
-Example:
+The following placeholders are supported:
+
+- `created_at`: the resource's creation date
+- `updated_at`: the resource's last update date
+- `closed_at`: the resource's closed date (if applicable)
+- `merged_at`: the resource's merged date (if applicable)
+- `state`: the resources's current state: `opened`, `closed`, `merged`
+- `author`: the username of the resource's author as `@user1`
+- `assignee`: the username of the resource's assignee as `@user1`
+- `assignees`: the usernames of the resource's assignees as `@user1, @user2`
+- `closed_by`: the user that closed the resource as `@user1` (if applicable)
+- `merged_by`: the user that merged the resource as `@user1` (if applicable)
+- `milestone`: the resource's current milestone
+- `labels`: the resource's labels as `~label1, ~label2`
+- `upvotes`: the resources's upvotes count
+- `downvotes`: the resources's downvotes count
+
+If the resource doesn't respond to the placeholder, or if the field is `nil`,
+the placeholder is not replaced.
+
+Example without placeholders:
 
 ```yml
 actions:
@@ -339,6 +360,14 @@ actions:
     Closing this issue automatically
 ```
 
+Example with placeholders:
+
+```yml
+actions:
+  comment: |
+    @{{author}} Are you still interested in finishing this merge request?
+```
+
 ### Usage
 
 ```
@@ -348,6 +377,7 @@ Usage: gitlab-triage [options]
     -f, --policies-file [string]     A valid policies YML file
     -p, --project-id [string]        A project ID or path
     -t, --token [string]             A valid API token
+    -H, --host-url [string]          A valid host url
     -d, --debug                      Print debug information
     -h, --help                       Print help message
         --init                       Initialize the project with a policy file
@@ -378,6 +408,21 @@ run:triage:triage:
 
 > Note: You can use the [`--init-ci`](#usage) option to add an example [`.gitlab-ci.yml` file](support/.gitlab-ci.example.yml) to your project
 
+#### Can I use gitlab-triage for my self-hosted GitLab instance?
+
+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
+```
+
+##### Policy file
+```yml
+host_url: https://gitlab.host.com
+resource_rules:
+```
+
 ### Contributing
 
 Please refer to the [Contributing Guide](CONTRIBUTING.md)

data/bin/gitlab-triage

@@ -9,13 +9,15 @@ Options = Struct.new(
   :policies_file,
   :project_id,
   :token,
-  :debug
+  :debug,
+  :host_url
 )
 
 class TriageOptionParser
   class << self
     def parse(argv)
       options = Options.new
+      options.host_url = 'https://gitlab.com'
 
       parser = OptionParser.new do |opts|
         opts.banner = "Usage: #{__FILE__} [options]\n\n"
@@ -36,6 +38,10 @@ class TriageOptionParser
           options.token = value
         end
 
+        opts.on('-H', '--host-url [string]', String, 'A valid host url') do |value|
+          options.host_url = value
+        end
+
         opts.on('-d', '--debug', 'Print debug information') do |value|
           options.debug = value
         end

data/lib/gitlab/triage/command_builders/base_command_builder.rb

@@ -3,7 +3,7 @@ module Gitlab
     module CommandBuilders
       class BaseCommandBuilder
         def initialize(items)
-          @items = [items].flatten
+          @items = Array(items)
           @items.delete('')
         end
 
@@ -21,6 +21,10 @@ module Gitlab
           ' '
         end
 
+        def slash_command_string
+          nil
+        end
+
         def content_string
           @items.map do |item|
             format_item(item)

data/lib/gitlab/triage/command_builders/comment_body_builder.rb

@@ -0,0 +1,66 @@
+require_relative 'base_command_builder'
+
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class CommentBodyBuilder < BaseCommandBuilder
+        SUPPORTED_PLACEHOLDERS = {
+          created_at: "{{created_at}}".freeze,
+          updated_at: "{{updated_at}}".freeze,
+          closed_at: "{{closed_at}}".freeze,
+          merged_at: "{{merged_at}}".freeze,
+          state: "{{state}}".freeze,
+          author: "@{{author.username}}".freeze,
+          assignee: "@{{assignee.username}}".freeze,
+          assignees: "@{{assignees.username}}".freeze,
+          closed_by: "@{{closed_by.username}}".freeze,
+          merged_by: "@{{merged_by.username}}".freeze,
+          milestone: %(%"{{milestone.title}}").freeze,
+          labels: %(~"{{labels}}").freeze,
+          upvotes: "{{upvotes}}".freeze,
+          downvotes: "{{downvotes}}".freeze
+        }.freeze
+        PLACEHOLDER_REGEX = /{{([\w\.]+)}}/
+
+        attr_reader :resource
+
+        def initialize(items, resource: nil)
+          super(items)
+          @resource = resource
+        end
+
+        private
+
+        def separator
+          "\n\n"
+        end
+
+        def format_item(item)
+          return item unless resource
+
+          SUPPORTED_PLACEHOLDERS.each do |placeholder, formatted_text|
+            next unless item.include?("{{#{placeholder}}}")
+
+            methods = formatted_text.match(/.*#{PLACEHOLDER_REGEX}.*/)[1].split('.')
+            fields = resource_fields(resource, methods)
+
+            final_fields = fields.map { |field| formatted_text.sub(PLACEHOLDER_REGEX, field.to_s) }
+            item.gsub!("{{#{placeholder}}}", final_fields.join(', ')) if final_fields.any?
+          end
+
+          item
+        end
+
+        def resource_fields(resource, methods)
+          method = methods.shift
+
+          return Array(resource) unless method && resource
+          return [] unless resource.key?(method)
+
+          sub_resources = resource[method]
+          Array.wrap(sub_resources).flat_map { |res| resource_fields(res, methods.dup) }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/command_builders/comment_command_builder.rb

@@ -10,10 +10,6 @@ module Gitlab
           "\n\n"
         end
 
-        def slash_command_string
-          nil
-        end
-
         def format_item(item)
           item
         end

data/lib/gitlab/triage/engine.rb

@@ -6,6 +6,7 @@ require_relative 'limiters/forbidden_labels_conditions_limiter'
 require_relative 'limiters/no_additional_labels_conditions_limiter'
 require_relative 'limiters/author_member_conditions_limiter'
 require_relative 'limiters/assignee_member_conditions_limiter'
+require_relative 'command_builders/comment_body_builder'
 require_relative 'command_builders/comment_command_builder'
 require_relative 'command_builders/label_command_builder'
 require_relative 'command_builders/remove_label_command_builder'
@@ -24,7 +25,7 @@ module Gitlab
       attr_reader :host_url, :api_version, :per_page, :policies, :options
 
       def initialize(policies:, options:, network_adapter_class: Gitlab::Triage::NetworkAdapters::HttpartyAdapter)
-        @host_url = policies.delete(:host_url) { 'https://gitlab.com' }
+        @host_url = policies.delete(:host_url) { options.host_url }
         @api_version = policies.delete(:api_version) { 'v4' }
         @per_page = policies.delete(:per_page) { 100 }
         @policies = policies
@@ -110,23 +111,23 @@ module Gitlab
       end
 
       def process_resources(resource_type, resources, rule)
-        comment = build_comment(rule_actions(rule))
+        resources.each do |resource|
+          comment = build_comment(rule_actions(rule), resource: resource)
 
-        if options.dry_run && resources.any?
-          puts "\nThe following comment would be posted for the rule '#{rule[:name]}':\n\n"
-          puts ">>>\n#{comment}\n>>>"
-          return
-        end
+          if options.dry_run
+            puts "\nThe following comment would be posted for the rule '#{rule[:name]}':\n\n"
+            puts ">>>\n#{comment}\n>>>"
+            break
+          end
 
-        resources.each do |resource|
           network.post_api(options.token, build_post_url(resource_type, resource), comment)
         end
       end
 
-      def build_comment(actions)
+      def build_comment(actions, resource: nil)
         CommandBuilders::CommentCommandBuilder.new(
           [
-            actions[:comment],
+            CommandBuilders::CommentBodyBuilder.new(actions[:comment], resource: resource).build_command,
             CommandBuilders::LabelCommandBuilder.new(actions[:labels]).build_command,
             CommandBuilders::RemoveLabelCommandBuilder.new(actions[:remove_labels]).build_command,
             CommandBuilders::CcCommandBuilder.new(actions[:mention]).build_command,

data/lib/gitlab/triage/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Triage
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-triage
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,7 @@ files:
 - lib/gitlab/triage.rb
 - lib/gitlab/triage/command_builders/base_command_builder.rb
 - lib/gitlab/triage/command_builders/cc_command_builder.rb
+- lib/gitlab/triage/command_builders/comment_body_builder.rb
 - lib/gitlab/triage/command_builders/comment_command_builder.rb
 - lib/gitlab/triage/command_builders/label_command_builder.rb
 - lib/gitlab/triage/command_builders/remove_label_command_builder.rb