use more descriptive names in atd files and cli options

Author: yasunariw

documentation/config_docs.md

@@ -10,13 +10,13 @@ Config file is where the variables affecting the behaviour of notabot are define
     "offline": "github-api-cache",
     "main_branch_name": "develop",
     "status_rules": {
-      ...
+        ...
     },
     "prefix_rules": {
-      ...
+        ...
     },
     "label_rules": {
-      ...
+        ...
     },
     "suppress_cancelled_events": true
 }
@@ -36,7 +36,7 @@ Config file is where the variables affecting the behaviour of notabot are define
 **example**
 ```json
 "status_rules": {
-    "title": [
+    "allowed_pipelines": [
         "default",
         "buildkite/pipeline2"
     ],
@@ -75,54 +75,54 @@ Label rules apply to PR and issues notifications.
 **example**
 ```json
 "label_rules": {
-    "default": "default",
+    "default_channel": "default",
     "rules": [
         {
-            "label_name": [
+            "allow": [
                 "backend"
             ],
             "ignore": [],
-            "chan": "backend"
+            "channel": "backend"
         },
         {
-            "label_name": [
+            "allow": [
                 "a1"
             ],
             "ignore": [],
-            "chan": "a1-bot"
+            "channel": "a1-bot"
         },
         {
-            "label_name": [
+            "allow": [
                 "a3"
             ],
             "ignore": [],
-            "chan": "a3"
+            "channel": "a3"
         },
         {
-            "label_name": [],
+            "allow": [],
             "ignore": [
                 "backend",
                 "a1",
                 "a3"
             ],
-            "chan": "frontend-bot"
+            "channel": "frontend-bot"
         }
     ]
 },
 ```
 
 | value | description | optional | default |
 |-|-|-|-|
-| `default` | default channel to notify if no rules match | Yes | no channels will be notified on default |
+| `default_channel` | default channel to notify if no rules match | Yes | no channels will be notified on default |
 | `rules` | list of `label_rule` objects | No | - |
 
 ### Label Rule
 
 | value | description | optional | default |
 |-|-|-|-|
-| `label_name` | whitelist of label values that match this rule; if list is empty it vacuously satisfies the rule | No | - |
+| `allow` | whitelist of label values that match this rule; if list is empty it vacuously satisfies the rule | No | - |
 | `ignore` | blacklist of label values; any labels matching will not match the rule | No | - |
-| `chan` | channel to use as webhook if matching this label rule | No | - |
+| `channel` | channel to use as webhook if matching this label rule | No | - |
 
 ## Prefix Config
 
@@ -133,27 +133,27 @@ The prefix config object is exactly the same as **Label Config** except its `rul
 **example**
 ```json
 "prefix_rules": {
-    "default": "default",
+    "default_channel": "default",
     "rules": [
         {
-            "prefix": [
+            "allow": [
                 "backend/a1"
             ],
             "ignore": [],
-            "chan": "a1"
+            "channel": "a1"
         },
         {
-            "prefix": [
+            "allow": [
                 "backend/a5",
                 "backend/a4"
             ],
             "ignore": [],
-            "chan": "backend"
+            "channel": "backend"
         },
         {
-            "prefix": [],
+            "allow": [],
             "ignore": [],
-            "chan": "all-push-events"
+            "channel": "all-push-events"
         }
     ]
 },
@@ -164,6 +164,6 @@ The prefix config object is exactly the same as **Label Config** except its `rul
 
 | value | description | optional | default |
 |-|-|-|-|
-| `prefix` | whitelist of strings that if prefixed in the filename matches the rule | No | - |
+| `allow` | whitelist of strings that if prefixed in the filename matches the rule | No | - |
 | `ignore` | blacklist of strings that if prefixed in the filename does not match the rule | No | - |
-| `chan` | channel to use as webhook if matching this prefix rule | No | - |
+| `channel` | channel to use as webhook if matching this prefix rule | No | - |

documentation/secret_docs.md

@@ -7,7 +7,7 @@ Secret file is where sensitive information such as the urls used for webhooks an
 **example**
 ```json
 {
-    "slack_channels": [
+    "slack_hooks": [
         {
             "url": "https://slack_webhook_url",
             "channel": "default"
@@ -42,7 +42,7 @@ Secret file is where sensitive information such as the urls used for webhooks an
 
 | value | description | optional | default |
 |-|-|-|-|
-| `slack_channels` | list of webhook config objects | No | - |
+| `slack_hooks` | list of webhook config objects | No | - |
 | `gh_token` | must not be specified for public repositories | Yes | - |
 | `gh_webhook_secret` | if not specified signatures will not be checked | Yes | - |
 

lib/action.ml

@@ -13,7 +13,7 @@ type prefix_match =
   | Match of int
   | NoMatch
 
-let chan_of_prefix_rule (r : prefix_rule) = r.chan
+let chan_of_prefix_rule (r : prefix_rule) = r.channel_name
 
 let touching_prefix (rule : Notabot_t.prefix_rule) name =
   let match_lengths filename prefixes =
@@ -24,10 +24,10 @@ let touching_prefix (rule : Notabot_t.prefix_rule) name =
   match match_lengths name rule.ignore with
   | _ :: _ -> NoMatch
   | [] ->
-  match rule.prefix with
+  match rule.allow with
   | [] -> Match 0
   | _ ->
-  match List.max_elt (match_lengths name rule.prefix) ~compare:Int.compare with
+  match List.max_elt (match_lengths name rule.allow) ~compare:Int.compare with
   | Some x -> Match x
   | None -> NoMatch
 
@@ -58,7 +58,7 @@ let unique_chans_of_files rules files =
 
 let touching_label rule name =
   let name_lc = String.lowercase name in
-  let label_lc = List.map rule.label_name ~f:(fun l -> String.lowercase l) in
+  let label_lc = List.map rule.allow ~f:(fun l -> String.lowercase l) in
   let ignore_lc = List.map rule.ignore ~f:(fun l -> String.lowercase l) in
   (* convert both labels and config into lowe-case to make label matching case-insensitive *)
   (List.is_empty label_lc || List.mem ~equal:String.equal label_lc name_lc)
@@ -93,7 +93,9 @@ let group_commit chan l =
     | true -> Some commit)
 
 let partition_push cfg n =
-  let default commit = Option.value_map cfg.prefix_rules.default ~default:[] ~f:(fun webhook -> [ webhook, commit ]) in
+  let default commit =
+    Option.value_map cfg.prefix_rules.default_channel ~default:[] ~f:(fun webhook -> [ webhook, commit ])
+  in
   let rules = cfg.prefix_rules.rules in
   let channels =
     n.commits
@@ -110,7 +112,10 @@ let partition_push cfg n =
     |> List.concat
   in
   let prefix_chans =
-    let chans = Option.to_list cfg.prefix_rules.default @ List.map rules ~f:(fun (rule : prefix_rule) -> rule.chan) in
+    let chans =
+      Option.to_list cfg.prefix_rules.default_channel
+      @ List.map rules ~f:(fun (rule : prefix_rule) -> rule.channel_name)
+    in
     List.dedup_and_sort chans ~compare:String.compare
   in
   List.filter_map prefix_chans ~f:(fun chan ->
@@ -123,10 +128,10 @@ let filter_label rules (label : Github_j.label) =
   |> List.filter_map ~f:(fun rule ->
        match touching_label rule label.name with
        | false -> None
-       | true -> Some rule.chan)
+       | true -> Some rule.channel_name)
 
 let partition_label cfg (labels : Github_j.label list) =
-  let default = Option.to_list cfg.label_rules.default in
+  let default = Option.to_list cfg.label_rules.default_channel in
   match labels with
   | [] -> default
   | labels ->
@@ -180,7 +185,7 @@ let partition_commit cfg files =
   let names = List.map ~f:(fun f -> f.filename) files in
   match unique_chans_of_files cfg.prefix_rules.rules names with
   | _ :: _ as xs -> xs
-  | [] -> Option.to_list cfg.prefix_rules.default
+  | [] -> Option.to_list cfg.prefix_rules.default_channel
 
 let hide_cancelled (notification : status_notification) cfg =
   let find_cancelled status_state =
@@ -216,7 +221,7 @@ let hide_success (n : status_notification) (ctx : Context.t) =
 let partition_status (ctx : Context.t) (n : status_notification) =
   let cfg = ctx.cfg in
   let get_commit_info () =
-    let default () = Lwt.return @@ Option.to_list cfg.prefix_rules.default in
+    let default () = Lwt.return @@ Option.to_list cfg.prefix_rules.default_channel in
     match cfg.main_branch_name with
     | None -> default ()
     | Some main_branch_name ->
@@ -263,7 +268,7 @@ let partition_status (ctx : Context.t) (n : status_notification) =
   res
 
 let partition_commit_comment cfg n =
-  let default = Option.to_list cfg.prefix_rules.default in
+  let default = Option.to_list cfg.prefix_rules.default_channel in
   match n.comment.path with
   | None ->
     ( match%lwt Github.generate_commit_from_commit_comment cfg n with
@@ -308,25 +313,25 @@ let generate_notifications (ctx : Context.t) req =
 let print_prefix_routing rules =
   let show_match l = String.concat ~sep:" or " @@ List.map ~f:(fun s -> s ^ "*") l in
   rules
-  |> List.iter ~f:(fun rule ->
+  |> List.iter ~f:(fun (rule : prefix_rule) ->
        begin
-         match rule.prefix, rule.ignore with
+         match rule.allow, rule.ignore with
          | [], [] -> Stdio.printf "  any"
          | l, [] -> Stdio.printf "  %s" (show_match l)
          | [], l -> Stdio.printf "  not %s" (show_match l)
          | l, i -> Stdio.printf "  %s and not %s" (show_match l) (show_match i)
        end;
-       Stdio.printf " -> #%s\n%!" rule.chan)
+       Stdio.printf " -> #%s\n%!" rule.channel_name)
 
 let print_label_routing rules =
   let show_match l = String.concat ~sep:" or " l in
   rules
-  |> List.iter ~f:(fun rule ->
+  |> List.iter ~f:(fun (rule : label_rule) ->
        begin
-         match rule.label_name, rule.ignore with
+         match rule.allow, rule.ignore with
          | [], [] -> Stdio.printf "  any"
          | l, [] -> Stdio.printf "  %s" (show_match l)
          | [], l -> Stdio.printf "  not %s" (show_match l)
          | l, i -> Stdio.printf "  %s and not %s" (show_match l) (show_match i)
        end;
-       Stdio.printf " -> #%s\n%!" rule.chan)
+       Stdio.printf " -> #%s\n%!" rule.channel_name)

lib/config.ml

@@ -13,8 +13,8 @@ type status_rules = {
 
 type t = {
   chans : string Chan_map.t;
-  prefix_rules : Notabot_t.prefix_config;
-  label_rules : Notabot_t.label_config;
+  prefix_rules : Notabot_t.prefix_rules;
+  label_rules : Notabot_t.label_rules;
   gh_webhook_secret : string option;
   main_branch_name : string option;
   gh_token : string option;
@@ -29,44 +29,44 @@ let make (json_config : Notabot_t.config) (secrets : Notabot_t.secrets) =
         match Chan_map.find_opt webhook.channel acc with
         | None -> Chan_map.add webhook.channel webhook.url acc
         | Some c -> Exn.fail "chan %s is defined multiple time in the config" c)
-      Chan_map.empty secrets.slack_channels
+      Chan_map.empty secrets.slack_hooks
   in
   let () =
     List.iteri
-      (fun i ({ chan; _ } : Notabot_t.prefix_rule) ->
-        match Chan_map.find_opt chan chans with
-        | None -> Exn.fail "chan %s in prefix_rules %d is missing from slack_channels" chan i
+      (fun i ({ channel_name; _ } : Notabot_t.prefix_rule) ->
+        match Chan_map.find_opt channel_name chans with
+        | None -> Exn.fail "chan %s in prefix_rules %d is missing from slack_hooks" channel_name i
         | Some _ -> ())
       json_config.prefix_rules.rules
   in
   let () =
     List.iteri
-      (fun i ({ chan; _ } : Notabot_t.label_rule) ->
-        match Chan_map.find_opt chan chans with
-        | None -> Exn.fail "chan %s in labels_rules %d is missing from slack_channels" chan i
+      (fun i ({ channel_name; _ } : Notabot_t.label_rule) ->
+        match Chan_map.find_opt channel_name chans with
+        | None -> Exn.fail "chan %s in labels_rules %d is missing from slack_hooks" channel_name i
         | Some _ -> ())
       json_config.label_rules.rules
   in
   let () =
-    match json_config.prefix_rules.default with
+    match json_config.prefix_rules.default_channel with
     | None -> ()
     | Some d ->
     match Chan_map.find_opt d chans with
-    | None -> Exn.fail "default chan %s in prefix_rules is missing from slack_channels" d
+    | None -> Exn.fail "default chan %s in prefix_rules is missing from slack_hooks" d
     | Some _ -> ()
   in
   let () =
-    match json_config.label_rules.default with
+    match json_config.label_rules.default_channel with
     | None -> ()
     | Some d ->
     match Chan_map.find_opt d chans with
-    | None -> Exn.fail "default chan %s in label_rules is missing from slack_channels" d
+    | None -> Exn.fail "default chan %s in label_rules is missing from slack_hooks" d
     | Some _ -> ()
   in
   let status_rules =
     let status =
       let open Github_t in
-      let j = json_config.status_rules.status in
+      let j = json_config.status_rules.rules in
       List.filter_map id
         [
           ( match j.success with
@@ -83,7 +83,7 @@ let make (json_config : Notabot_t.config) (secrets : Notabot_t.secrets) =
           );
         ]
     in
-    { title = json_config.status_rules.title; status }
+    { title = json_config.status_rules.allowed_pipelines; status }
   in
   {
     chans;