Merge branch 'main' into joss

Author: xuanxu

.github/workflows/tests.yml

@@ -7,13 +7,13 @@ jobs:
     continue-on-error: ${{ matrix.failure-allowed }}
     strategy:
       matrix:
-        ruby-version: ['3.2.7', '3.3.7', '3.4.2']
+        ruby-version: ['3.2', '3.3', '3.4']
         failure-allowed: [false]
         include:
-        - ruby-version: 'truffleruby'
+        - ruby-version: '4.0'
           failure-allowed: true
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

Gemfile.lock

@@ -1,23 +1,23 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     base64 (0.3.0)
     bibtex-ruby (6.2.0)
       latex-decode (~> 0.0)
       logger (~> 1.7)
       racc (~> 1.7)
-    bigdecimal (3.3.1)
-    cgi (0.5.0)
+    bigdecimal (4.0.1)
+    cgi (0.5.1)
     charlock_holmes (0.7.9)
     chronic (0.10.2)
-    connection_pool (2.5.4)
+    connection_pool (3.0.2)
     crack (1.0.1)
       bigdecimal
       rexml
     diff-lcs (1.6.2)
-    dotenv (3.1.8)
+    dotenv (3.2.0)
     faraday (2.14.0)
       faraday-net_http (>= 2.0, < 3.5)
       json
@@ -26,9 +26,9 @@ GEM
       faraday (>= 1, < 3)
     faraday-net_http (3.4.2)
       net-http (~> 0.5)
-    faraday-retry (2.3.2)
+    faraday-retry (2.4.0)
       faraday (~> 2.0)
-    github-linguist (9.3.0)
+    github-linguist (9.4.0)
       cgi
       charlock_holmes (~> 0.7.7)
       mini_mime (~> 1.0)
@@ -37,8 +37,8 @@ GEM
     issue (1.0.2)
       openssl (~> 3.2)
       rack (~> 3.1)
-    json (2.16.0)
-    latex-decode (0.4.0)
+    json (2.18.0)
+    latex-decode (0.4.2)
     licensee (9.18.0)
       dotenv (>= 2, < 4)
       octokit (>= 4.20, < 10.0)
@@ -48,13 +48,13 @@ GEM
     logger (1.7.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
-    multi_json (1.17.0)
+    multi_json (1.19.1)
     mustermann (3.0.4)
       ruby2_keywords (~> 0.0.1)
-    net-http (0.8.0)
+    net-http (0.9.1)
       uri (>= 0.11.1)
     nio4r (2.7.5)
-    nokogiri (1.18.10)
+    nokogiri (1.19.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (9.2.0)
@@ -63,8 +63,8 @@ GEM
     ojra (1.1.1)
       faraday (~> 2.9)
     openssl (3.3.2)
-    public_suffix (6.0.2)
-    puma (7.1.0)
+    public_suffix (7.0.2)
+    puma (7.2.0)
       nio4r (~> 2.0)
     racc (1.8.1)
     rack (3.2.4)
@@ -77,9 +77,9 @@ GEM
       rack (>= 3.0.0)
     rack-test (2.2.0)
       rack (>= 1.3)
-    redis-client (0.26.1)
+    redis-client (0.26.3)
       connection_pool
-    reverse_markdown (3.0.0)
+    reverse_markdown (3.0.2)
       nokogiri
     rexml (3.4.4)
     rspec (3.13.2)
@@ -106,12 +106,12 @@ GEM
       multi_json (~> 1.15)
       rexml (~> 3.2, >= 3.2.5)
       thor (~> 1.2, >= 1.2.1)
-    sidekiq (8.0.9)
-      connection_pool (>= 2.5.0)
-      json (>= 2.9.0)
-      logger (>= 1.6.2)
-      rack (>= 3.1.0)
-      redis-client (>= 0.23.2)
+    sidekiq (8.1.0)
+      connection_pool (>= 3.0.0)
+      json (>= 2.16.0)
+      logger (>= 1.7.0)
+      rack (>= 3.2.0)
+      redis-client (>= 0.26.0)
     sinatra (4.2.1)
       logger (>= 1.6.0)
       mustermann (~> 3.0)
@@ -125,8 +125,8 @@ GEM
       rack-protection (= 4.2.1)
       sinatra (= 4.2.1)
       tilt (~> 2.0)
-    thor (1.4.0)
-    tilt (2.6.1)
+    thor (1.5.0)
+    tilt (2.7.0)
     uri (1.1.1)
     webmock (3.26.1)
       addressable (>= 2.8.0)

app/lib/defaults.rb

@@ -3,7 +3,7 @@
 module Defaults
 
   # Default value for needed env settings.
-  # Can be overriden from the config/settings YAML file.
+  # Can be overridden from the config/settings YAML file.
   def default_settings
     @defaults ||= Sinatra::IndifferentHash[
       bot_github_user: ENV['BUFFY_BOT_GH_USER'],

app/lib/responder.rb

@@ -295,14 +295,14 @@ def process_reverse_labeling
 
   # Finds the value of the url of the target-repository in the body of the issue
   # by default reads the field called "target-repository"
-  # unless a diferent name is set using param :url_field
+  # unless a different name is set using param :url_field
   def target_repo_value
     @target_repo_url ||= value_of_or_default(params[:url_field], "target-repository")
   end
 
   # Finds the name of the branch in the body of the issue
   # by default reads the field called "branch"
-  # unless a diferent name is set using param :branch_field
+  # unless a different name is set using param :branch_field
   # or if it comes in the match_data in the specified position
   def branch_name_value(branch_index=1)
     if @match_data.nil? || @match_data[branch_index].nil?
@@ -317,12 +317,12 @@ def hidden?
     params[:hidden] == true
   end
 
-  # Default description can be overriden by config param
+  # Default description can be overridden by config param
   def description
     params[:description] || default_description
   end
 
-  # Default example_invocation can be overriden by config param
+  # Default example_invocation can be overridden by config param
   def example_invocation
     params[:example_invocation] || default_example_invocation
   end

docs/configuration.md

@@ -172,8 +172,8 @@ The _env_ section is used to declare general key/value settings. For security re
   <dd>This setting is used to impose conditions on the responder. It can include several options:
 
 ```eval_rst
-:title: *<String>* or *<Regular Expresion>* Responder will run only if issue' title matches this.
-:body: *<String>* or *<Regular Expresion>* Responder will run only if the body of the issue matches this.
+:title: *<String>* or *<Regular Expression>* Responder will run only if issue' title matches this.
+:body: *<String>* or *<Regular Expression>* Responder will run only if the body of the issue matches this.
 :value_exists: *<String>* Responder will run only if there is a not empty value for this in the issue (marked with HTML comments).
 :value_matches: *<Hash>* Responder will run only if the param values (marked with HTML comments) in the body of the issue matches the ones specified here.
 :role_assigned: *<String>* Responder will be run only if there is a username assigned for the specified value.

docs/custom_responder.md

@@ -74,7 +74,7 @@ When an event is sent from the reviews repository to Buffy, only responders that
 #### Event regex
 The _@event_regex_ variable is where the syntax of every specific command is declared. If it is `nil` the responder will respond to every event that matches _@event_action_.
 
-Inside this method you have available the name of the bot in the `@botname` instace variable and all the parameters for this responder from the config file in the `@params` instance variable.
+Inside this method you have available the name of the bot in the `@botname` instance variable and all the parameters for this responder from the config file in the `@params` instance variable.
 
 For our example, we will be listening to comments and we want the command to be "what time is it?":
 ```ruby

docs/installation.md

@@ -36,7 +36,7 @@ This will be the "user" responding to the commands issued from a reviews reposit
 Some applications and services must be available to use by Buffy:
 
 - **[Redis](https://redis.io/)**: To process background jobs Buffy needs `redis` installed.
-- **[cloc](https://github.com/AlDanial/cloc)**: The *Respository Checks Responder* can analyze source code, to run this check `cloc` is used.
+- **[cloc](https://github.com/AlDanial/cloc)**: The *Repository Checks Responder* can analyze source code, to run this check `cloc` is used.
 
 #### Deployment
 

docs/labeling.md

@@ -24,7 +24,7 @@ Responders allowing labeling will accept in their settings two keys:
         - pending-review
 ...
 ```
-If the example responder is successfull the `review-finished` and `recommend publication` labels will be added and the `pending-review` label will be removed from the issue.
+If the example responder is successful the `review-finished` and `recommend publication` labels will be added and the `pending-review` label will be removed from the issue.
 
 ## Responders listening to Add/Remove actions
 

docs/responders/external_service.md

@@ -116,7 +116,7 @@ Later, a POST request will be sent to https://dummy-external-service.herokuapp.c
  "secret": "A1234567890Z", # declared in the query_params setting
  "target-repo":"...",      # the value is extracted from the body of the issue
  "id":"...",               # the value corresponds to issue_id, it has been mapped to id
- "repo":"...",             # the origin repo where the invocation happend
+ "repo":"...",             # the origin repo where the invocation happened
  "sender":"...",           # the user invoking the command
  "bot_name":"...",         # the bot user name that will be responding
 }

docs/responders/goodbye.md

@@ -41,7 +41,7 @@ To reply with a template file:
 
 Calling an external service:
 ```eval_rst
-:external_service: All the configuration for the service is nested under this param. Posible options are:
+:external_service: All the configuration for the service is nested under this param. Possible options are:
 
   :name: *Required*. The name for this service.
   :url: *Required*. The url to call.
@@ -105,7 +105,7 @@ When a new issue is closed the responder will send a POST request to https://dum
  "secret": "A1234567890Z", # declared in the query_params setting
  "target-repo":"...",      # the value is extracted from the body of the issue
  "id":"...",               # the value corresponds to issue_id, it has been mapped to id
- "repo":"...",             # the origin repo where the invocation happend
+ "repo":"...",             # the origin repo where the invocation happened
  "sender":"...",           # the user invoking the command
  "bot_name":"...",         # the bot user name that will be responding
 }