Skip to content

Commit 0825483

Browse files
authored
Renames report commands so it's easier to find them (Netflix#512)
* Renames report commands * Updates docs
1 parent 90bc132 commit 0825483

6 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎docs/configuration/plugins/configuring-slack.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,11 @@ groups:read
121121
122122
### Commands
123123

124-
#### `SLACK_COMMAND_TACTICAL_REPORT_SLUG` \[Optional. Default: '/dispatch-tactical-report'\]
124+
#### `SLACK_COMMAND_REPORT_TACTICAL_SLUG` \[Optional. Default: '/dispatch-report-tactical'\]
125125

126126
> Opens a dialog to write a tactical report.
127127
128-
#### `SLACK_COMMAND_EXECUTIVE_REPORT_SLUG` \[Optional. Default: '/dispatch-executive-report'\]
128+
#### `SLACK_COMMAND_REPORT_EXECUTIVE_SLUG` \[Optional. Default: '/dispatch-report-executive'\]
129129

130130
> Opens a dialog to write an executive report.
131131

‎src/dispatch/plugins/dispatch_slack/actions.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
from .config import (
2020
SLACK_COMMAND_ASSIGN_ROLE_SLUG,
2121
SLACK_COMMAND_ENGAGE_ONCALL_SLUG,
22-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG,
23-
SLACK_COMMAND_TACTICAL_REPORT_SLUG,
22+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG,
23+
SLACK_COMMAND_REPORT_TACTICAL_SLUG,
2424
SLACK_COMMAND_UPDATE_INCIDENT_SLUG,
2525
)
2626

@@ -133,8 +133,8 @@ def dialog_action_functions(action: str):
133133
action_mappings = {
134134
SLACK_COMMAND_ASSIGN_ROLE_SLUG: [handle_assign_role_action],
135135
SLACK_COMMAND_ENGAGE_ONCALL_SLUG: [incident_flows.incident_engage_oncall_flow],
136-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG: [report_flows.create_executive_report],
137-
SLACK_COMMAND_TACTICAL_REPORT_SLUG: [report_flows.create_tactical_report],
136+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG: [report_flows.create_executive_report],
137+
SLACK_COMMAND_REPORT_TACTICAL_SLUG: [report_flows.create_tactical_report],
138138
SLACK_COMMAND_UPDATE_INCIDENT_SLUG: [handle_update_incident_action],
139139
}
140140

‎src/dispatch/plugins/dispatch_slack/commands.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
from .config import (
1616
SLACK_COMMAND_ASSIGN_ROLE_SLUG,
1717
SLACK_COMMAND_ENGAGE_ONCALL_SLUG,
18-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG,
18+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG,
1919
SLACK_COMMAND_LIST_MY_TASKS_SLUG,
2020
SLACK_COMMAND_LIST_PARTICIPANTS_SLUG,
2121
SLACK_COMMAND_LIST_RESOURCES_SLUG,
2222
SLACK_COMMAND_LIST_TASKS_SLUG,
2323
SLACK_COMMAND_REPORT_INCIDENT_SLUG,
24-
SLACK_COMMAND_TACTICAL_REPORT_SLUG,
24+
SLACK_COMMAND_REPORT_TACTICAL_SLUG,
2525
SLACK_COMMAND_UPDATE_INCIDENT_SLUG,
2626
SLACK_COMMAND_UPDATE_NOTIFICATIONS_GROUP_SLUG,
2727
SLACK_COMMAND_UPDATE_PARTICIPANT_SLUG,
@@ -52,13 +52,13 @@ def command_functions(command: str):
5252
SLACK_COMMAND_ADD_TIMELINE_EVENT_SLUG: [create_add_timeline_event_modal],
5353
SLACK_COMMAND_ASSIGN_ROLE_SLUG: [create_assign_role_dialog],
5454
SLACK_COMMAND_ENGAGE_ONCALL_SLUG: [create_engage_oncall_dialog],
55-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG: [create_executive_report_dialog],
55+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG: [create_executive_report_dialog],
5656
SLACK_COMMAND_LIST_MY_TASKS_SLUG: [list_my_tasks],
5757
SLACK_COMMAND_LIST_PARTICIPANTS_SLUG: [list_participants],
5858
SLACK_COMMAND_LIST_RESOURCES_SLUG: [incident_flows.incident_list_resources_flow],
5959
SLACK_COMMAND_LIST_TASKS_SLUG: [list_tasks],
6060
SLACK_COMMAND_REPORT_INCIDENT_SLUG: [create_report_incident_modal],
61-
SLACK_COMMAND_TACTICAL_REPORT_SLUG: [create_tactical_report_dialog],
61+
SLACK_COMMAND_REPORT_TACTICAL_SLUG: [create_tactical_report_dialog],
6262
SLACK_COMMAND_UPDATE_INCIDENT_SLUG: [create_update_incident_dialog],
6363
SLACK_COMMAND_UPDATE_NOTIFICATIONS_GROUP_SLUG: [create_update_notifications_group_modal],
6464
SLACK_COMMAND_UPDATE_PARTICIPANT_SLUG: [create_update_participant_modal],

‎src/dispatch/plugins/dispatch_slack/config.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
SLACK_WORKSPACE_NAME = config("SLACK_WORKSPACE_NAME")
1414

1515
# Slash commands
16-
SLACK_COMMAND_TACTICAL_REPORT_SLUG = config(
17-
"SLACK_COMMAND_TACTICAL_REPORT_SLUG", default="/dispatch-tactical-report"
18-
)
1916
SLACK_COMMAND_LIST_TASKS_SLUG = config(
2017
"SLACK_COMMAND_LIST_TASKS_SLUG", default="/dispatch-list-tasks"
2118
)
@@ -43,8 +40,11 @@
4340
SLACK_COMMAND_REPORT_INCIDENT_SLUG = config(
4441
"SLACK_COMMAND_REPORT_INCIDENT_SLUG", default="/dispatch-report-incident"
4542
)
46-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG = config(
47-
"SLACK_COMMAND_EXECUTIVE_REPORT_SLUG", default="/dispatch-executive-report"
43+
SLACK_COMMAND_REPORT_TACTICAL_SLUG = config(
44+
"SLACK_COMMAND_REPORT_TACTICAL_SLUG", default="/dispatch-report-tactical"
45+
)
46+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG = config(
47+
"SLACK_COMMAND_REPORT_EXECUTIVE_SLUG", default="/dispatch-report-executive"
4848
)
4949
SLACK_COMMAND_UPDATE_NOTIFICATIONS_GROUP_SLUG = config(
5050
"SLACK_COMMAND_UPDATE_NOTIFICATIONS_GROUP_SLUG", default="/dispatch-notifications-group"

‎src/dispatch/plugins/dispatch_slack/messaging.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@
2121
SLACK_COMMAND_ADD_TIMELINE_EVENT_SLUG,
2222
SLACK_COMMAND_ASSIGN_ROLE_SLUG,
2323
SLACK_COMMAND_ENGAGE_ONCALL_SLUG,
24-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG,
24+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG,
2525
SLACK_COMMAND_LIST_MY_TASKS_SLUG,
2626
SLACK_COMMAND_LIST_PARTICIPANTS_SLUG,
2727
SLACK_COMMAND_LIST_RESOURCES_SLUG,
2828
SLACK_COMMAND_LIST_TASKS_SLUG,
2929
SLACK_COMMAND_REPORT_INCIDENT_SLUG,
30-
SLACK_COMMAND_TACTICAL_REPORT_SLUG,
30+
SLACK_COMMAND_REPORT_TACTICAL_SLUG,
3131
SLACK_COMMAND_UPDATE_INCIDENT_SLUG,
3232
SLACK_COMMAND_UPDATE_NOTIFICATIONS_GROUP_SLUG,
3333
SLACK_COMMAND_UPDATE_PARTICIPANT_SLUG,
@@ -37,10 +37,10 @@
3737
logger = logging.getLogger(__name__)
3838

3939

40-
INCIDENT_CONVERSATION_TACTICAL_REPORT_SUGGESTION = f"Consider providing a tactical report using the `{SLACK_COMMAND_TACTICAL_REPORT_SLUG}` command."
40+
INCIDENT_CONVERSATION_TACTICAL_REPORT_SUGGESTION = f"Consider providing a tactical report using the `{SLACK_COMMAND_REPORT_TACTICAL_SLUG}` command."
4141

4242
INCIDENT_CONVERSATION_COMMAND_MESSAGE = {
43-
SLACK_COMMAND_TACTICAL_REPORT_SLUG: {
43+
SLACK_COMMAND_REPORT_TACTICAL_SLUG: {
4444
"response_type": "ephemeral",
4545
"text": "Opening a dialog to write a tactical report...",
4646
},
@@ -80,7 +80,7 @@
8080
"response_type": "ephemeral",
8181
"text": "Opening a dialog to report an incident...",
8282
},
83-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG: {
83+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG: {
8484
"response_type": "ephemeral",
8585
"text": "Opening a dialog to write an executive report...",
8686
},

‎src/dispatch/plugins/dispatch_slack/plugin.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222
SLACK_API_BOT_TOKEN,
2323
SLACK_COMMAND_ASSIGN_ROLE_SLUG,
2424
SLACK_COMMAND_ENGAGE_ONCALL_SLUG,
25-
SLACK_COMMAND_EXECUTIVE_REPORT_SLUG,
25+
SLACK_COMMAND_REPORT_EXECUTIVE_SLUG,
2626
SLACK_COMMAND_LIST_PARTICIPANTS_SLUG,
2727
SLACK_COMMAND_LIST_RESOURCES_SLUG,
2828
SLACK_COMMAND_LIST_TASKS_SLUG,
29-
SLACK_COMMAND_TACTICAL_REPORT_SLUG,
29+
SLACK_COMMAND_REPORT_TACTICAL_SLUG,
3030
SLACK_COMMAND_UPDATE_INCIDENT_SLUG,
3131
SLACK_PROFILE_DEPARTMENT_FIELD_ID,
3232
SLACK_PROFILE_TEAM_FIELD_ID,
@@ -62,11 +62,11 @@
6262
ConversationCommands.assign_role: SLACK_COMMAND_ASSIGN_ROLE_SLUG,
6363
ConversationCommands.update_incident: SLACK_COMMAND_UPDATE_INCIDENT_SLUG,
6464
ConversationCommands.engage_oncall: SLACK_COMMAND_ENGAGE_ONCALL_SLUG,
65-
ConversationCommands.executive_report: SLACK_COMMAND_EXECUTIVE_REPORT_SLUG,
65+
ConversationCommands.executive_report: SLACK_COMMAND_REPORT_EXECUTIVE_SLUG,
6666
ConversationCommands.list_participants: SLACK_COMMAND_LIST_PARTICIPANTS_SLUG,
6767
ConversationCommands.list_resources: SLACK_COMMAND_LIST_RESOURCES_SLUG,
6868
ConversationCommands.list_tasks: SLACK_COMMAND_LIST_TASKS_SLUG,
69-
ConversationCommands.tactical_report: SLACK_COMMAND_TACTICAL_REPORT_SLUG,
69+
ConversationCommands.tactical_report: SLACK_COMMAND_REPORT_TACTICAL_SLUG,
7070
}
7171

7272

0 commit comments

Comments
 (0)