Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

outgoing_webhook: Separate command and text fields. #29922

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

salandei
Copy link
Collaborator

@salandei salandei commented May 2, 2024

This separates the slack legacy text field for slack-compatible outgoing webhook into command and text fields.
The command field contains the bot mention and the text field contains the content of the message after the bot mention. For better compatibility, the bot mention is transformed into Slack's slash command. e.g @mybot -> /mybot Test case for functionality is updated and api docs on the Slack-compatible format is updated.

Fixes: #19589

Screenshots and screen captures:

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

salandei and others added 3 commits April 29, 2024 17:17
Updated API documentation to clarify usage of outgoing webhooks and separate text from bot mentions.
Added the 'command' format to the list of tuple to display how data will be posted.
This separates the slack legacy text field for slack-compatible
outgoing webhook into command and text fields.
The command field contains the bot mention and the text field
contains the content of the message after the bot mention.
For better compatibility, the bot mention is transformed
into Slack's slash command. e.g @**mybot** ->  /mybot
Test case for functionality is updated and api docs
on the Slack-compatible format is updated.

Fixes zulip#19589.
@alya
Copy link
Contributor

alya commented May 2, 2024

@timabbott do you want to review this directly, or wait for @laurynmm to take a look?

@alya alya added the integration review Added by maintainers when a PR may be ready for integration. label May 2, 2024
@zulipbot
Copy link
Member

zulipbot commented May 2, 2024

Hello @zulip/server-integrations members, this pull request was labeled with the "area: integrations" label, so you may want to check it out!

@laurynmm
Copy link
Collaborator

There's an outstanding question about these changes impacting the python-zulip-api repository here: https://chat.zulip.org/#narrow/stream/127-integrations/topic/gitlab.20slash.20commands/near/1792657.

@laurynmm laurynmm removed the integration review Added by maintainers when a PR may be ready for integration. label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate command and text field for slack-compatible outgoing webhook
6 participants