Skip to content

Chore/wpb 20631 update welcome message #53

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.

Sign up for GitHub

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

Merged
MarianKijewski merged 3 commits into from
Jan 19, 2026
Merged

Chore/wpb 20631 update welcome message #53

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fccd382
add "github" prefix to the "help" command to ensure uniqueness
MarianKijewski Jan 17, 2026
e7f259e
apply common welcome message structure
MarianKijewski Jan 17, 2026
4639be9
specify that `/github help` is command
MarianKijewski Jan 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions src/main/kotlin/com/wire/github/EventsHandler.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ class EventsHandler : WireEventsHandlerSuspending() {
private val storage = redisConnection.sync()

override suspend fun onTextMessageReceived(wireMessage: WireMessage.Text) {
if (wireMessage.text.equals("/help", ignoreCase = true)) {
if (wireMessage.text.equals(HELP_COMMAND, ignoreCase = true)) {
logger.info(
"Event received. Event: TextMessageReceived (HELP command), " +
"conversationId: ${wireMessage.conversationId}, " +
"senderId: ${wireMessage.sender}"
)
val message = formatHelp(
val message = formatSetupInstructions(
conversationId = wireMessage.conversationId,
secret = storage.get(wireMessage.conversationId.toStorageKey())
)
Expand All @@ -50,7 +50,12 @@ class EventsHandler : WireEventsHandlerSuspending() {
"Event received. Event: AppAddedToConversation, " +
"conversationId: ${conversation.id}"
)
val message = formatHelp(conversationId = conversation.id)
val message = buildString {
appendLine(WELCOME_TEXT)
appendLine(formatSetupInstructions(conversationId = conversation.id))
appendLine()
append("Use the `$HELP_COMMAND` command to see the usage again.")
}

manager.sendMessage(
message = WireMessage.Text.create(
Expand All @@ -64,7 +69,7 @@ class EventsHandler : WireEventsHandlerSuspending() {
)
}

private fun formatHelp(
private fun formatSetupInstructions(
conversationId: QualifiedId,
secret: String? = null
): String {
Expand All @@ -81,8 +86,8 @@ class EventsHandler : WireEventsHandlerSuspending() {
conversationId.domain
)

val message = String.format(
"Hi, I'm GitHub App. Here is how to set me up:\n\n" +
val setupInstructions = String.format(
"Here is how to set me up:\n\n" +
"1. Go to the repository that you would like to connect to\n" +
"2. Go to **Settings / Webhooks / Add webhook**\n" +
"3. Add **Payload URL**: %s\n" +
Expand All @@ -92,10 +97,17 @@ class EventsHandler : WireEventsHandlerSuspending() {
generatedSecret
)

return message
return setupInstructions
}

private companion object {
const val HOST_URL_PATTERN = "%s/%s/%s"

const val WELCOME_TEXT =
"👋 Hi, I'm GitHub App. Thanks for adding me to the conversation.\n" +
"You can use me to receive GitHub notifications in Wire.\n" +
"I'm here to help make everyday work a little easier."

const val HELP_COMMAND = "/github help"
}
}