{"id":26289963,"url":"https://github.com/slack-samples/deno-triage-bot","last_synced_at":"2025-05-07T22:44:04.319Z","repository":{"id":214515996,"uuid":"681824924","full_name":"slack-samples/deno-triage-bot","owner":"slack-samples","description":"Generate reports for support requests submitted to public channels and configure regularly scheduled reporting","archived":false,"fork":false,"pushed_at":"2025-02-05T21:13:24.000Z","size":437,"stargazers_count":1,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-31T15:00:04.661Z","etag":null,"topics":["next-gen"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slack-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-22T20:53:06.000Z","updated_at":"2025-02-05T21:13:27.000Z","dependencies_parsed_at":"2023-12-28T17:56:27.280Z","dependency_job_id":"6cc09432-9163-4b84-8ebc-c2656b632388","html_url":"https://github.com/slack-samples/deno-triage-bot","commit_stats":null,"previous_names":["slack-samples/deno-triage-bot"],"tags_count":0,"template":false,"template_full_name":"slack-samples/deno-starter-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/deno-triage-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252967973,"owners_count":21833245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["next-gen"],"created_at":"2025-03-14T23:17:29.575Z","updated_at":"2025-05-07T22:44:04.296Z","avatar_url":"https://github.com/slack-samples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Triage Bot\n\nTriage Bot features workflows where users can generate reports for support\nrequests in Slack public channels. In addition, users can configure channels to\nreceive reports on a scheduled basis. A request is any message that begins with\na :white_circle:, :large_blue_circle:, or :red_circle: emoji. A message with\n:eyes: reaction is in progress. A message with :white_check_mark: reaction is\ndone.\n\n**Guide Outline**:\n\n- [Setup](#setup)\n  - [Install the Slack CLI](#install-the-slack-cli)\n  - [Clone the Sample App](#clone-the-sample-app)\n- [Running Your Project Locally](#running-your-project-locally)\n- [Included Workflows](#included-workflows)\n- [Creating Triggers](#creating-triggers)\n- [Datastores](#datastores)\n- [Testing](#testing)\n- [Deploying Your App](#deploying-your-app)\n- [Viewing Activity Logs](#viewing-activity-logs)\n- [Project Structure](#project-structure)\n- [Resources](#resources)\n\n---\n\n## Setup\n\nBefore getting started, first make sure you have a development workspace where\nyou have permission to install apps. **Please note that the features in this\nproject require that the workspace be part of\n[a Slack paid plan](https://slack.com/pricing).**\n\n### Install the Slack CLI\n\nTo use this sample, you need to install and configure the Slack CLI.\nStep-by-step instructions can be found in our\n[Quickstart Guide](https://api.slack.com/automation/quickstart).\n\n### Clone the Sample App\n\nStart by cloning this repository:\n\n```zsh\n# Clone this project onto your machine\n$ slack create my-app -t slack-samples/deno-triage-bot\n\n# Change into the project directory\n$ cd my-app\n```\n\n## Running Your Project Locally\n\nWhile building your app, you can see your changes appear in your workspace in\nreal-time with `slack run`. You'll know an app is the development version if the\nname has the string `(local)` appended.\n\n```zsh\n# Run app locally\n$ slack run\n\nConnected, awaiting events\n```\n\nTo stop running locally, press `\u003cCTRL\u003e + C` to end the process.\n\n## Included Workflows\n\nHere is the list of workflows for Triage Bot and steps to create them:\n\n- **Triagebot Help**: Post a private help message in the current channel.\n\n```zsh\n$ slack trigger create --trigger-def triggers/help_shortcut_trigger.ts\n```\n\n- **Triage**: Post a private triage report for the current channel.\n\n1. create the `private_report_shortcut_trigger` trigger\n\n```zsh\n$ slack trigger create --trigger-def triggers/private_report_shortcut_trigger.ts\n```\n\n2. Save the shortcut URL with name `private_shortcut` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"private_shortcut\", \"url\": \"shortcut url from step 1\"}}'\n```\n\n- **Triage Publish**: Post a public triage report for the current channel.\n\n1. create the `public_report_shortcut_trigger` trigger\n\n```zsh\n$ slack trigger create --trigger-def triggers/public_report_shortcut_trigger.ts\n```\n\n2. Save the shortcut URL with name `public_shortcut` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"public_shortcut\", \"url\": \"shortcut url from step 1\"}}'\n```\n\n- **Manage Triagebot Configuration**: Manage channel configuration for scheduled\n  posts and lookback days for triage requests. To get scheduled posts working,\n  you need to first create `private_report_webhook_trigger` and add the webhook\n  url to the `url` datastore.\n\n1. create the `private_report_webhook_trigger` trigger\n\n```zsh\n$ slack trigger create --trigger-def triggers/private_report_webhook_trigger.ts\n```\n\n2. Save the webhook URL with name `private_webhook` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"private_webhook\", \"url\": \"webhook url from step 1\"}}'\n```\n\n3. Run the following command to create the `post scheduled messages` workflow\n\n```zsh\n$ slack trigger create --trigger-def triggers/post_messages_scheduled_trigger.ts\n```\n\n4. Run the following command to create the `manage configuration` workflow\n\n```zsh\n$ slack trigger create --trigger-def triggers/manage_configuration_shortcut_trigger.ts\n```\n\n5. Save the shortcut URL with name `manage_shortcut` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"manage_shortcut\", \"url\": \"shortcut url from step 3\"}}'\n```\n\n- **Triage by lookback days**: Post a private triage report in the current\n  channel with the specified lookback days for triage requests. To get this\n  workflow to work, you need to create `public_report_webhook_trigger` and add\n  the webhook url to the `url` datastore.\n\n1. create the `public_report_webhook_trigger` trigger\n\n```zsh\n$ slack trigger create --trigger-def triggers/public_report_webhook_trigger.ts\n```\n\n2. Save the webhook URL with name `public_webhook` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"public_webhook\", \"url\": \"webhook url from step 1\"}}'\n```\n\n3. Run the following command to enable the `triage by days` workflow\n\n```zsh\n$ slack trigger create --trigger-def triggers/triage_by_days_shortcut_trigger.ts\n```\n\n4. Save the shortcut URL with name `triage_shortcut` in the `url` datastore\n\n```zsh\n$ slack datastore put '{\"datastore\": \"url\", \"app\": \"app_id\", \"item\": {\"name\": \"triage_shortcut\", \"url\": \"shortcut url from step 3\"}}'\n```\n\n## Creating Triggers\n\nIn the [previous section](#included-workflows) we've created different triggers.\n[Triggers](https://api.slack.com/automation/triggers) are what cause workflows\nto run. These triggers can be invoked by a user, or automatically as a response\nto an event within Slack.\n\nWhen you `run` or `deploy` your project for the first time, the CLI will prompt\nyou to create a trigger if one is found in the `triggers/` directory. For any\nsubsequent triggers added to the application, each must be\n[manually added using the `trigger create` command](#manual-trigger-creation).\nWe were creating triggers manually in\n[the Included Workflows section](#included-workflows).\n\nWhen creating triggers, you must select the workspace and environment that you'd\nlike to create the trigger in. Each workspace can have a local development\nversion (denoted by `(local)`), as well as a deployed version. _Triggers created\nin a local environment will only be available to use when running the\napplication locally._\n\n### Link Triggers\n\nA [link trigger](https://api.slack.com/automation/triggers/link) is a type of\ntrigger that generates a **Shortcut URL** which, when posted in a channel or\nadded as a bookmark, becomes a link. When clicked, the link trigger will run the\nassociated workflow.\n\nLink triggers are _unique to each installed version of your app_. This means\nthat Shortcut URLs will be different across each workspace, as well as between\n[locally run](#running-your-project-locally) and\n[deployed apps](#deploying-your-app).\n\nWith link triggers, after selecting a workspace and environment, the output\nprovided will include a Shortcut URL. Copy and paste this URL into a channel as\na message, or add it as a bookmark in a channel of the workspace you selected.\nInteracting with this link will run the associated workflow.\n\n**Note: triggers won't run the workflow unless the app is either running locally\nor deployed!**\n\n### Manual Trigger Creation\n\nTo manually create a trigger, use the following command:\n\n```zsh\n$ slack trigger create --trigger-def triggers/trigger.ts\n```\n\n## Datastores\n\nAll datastores can be found in the `/datastores` directory\n\n- `conf` - datastores for channel configurations.\n\n```\n{\n  \"channel_id\": \"C0A1B2C3D\",\n  \"lookback_days\": \"7\",\n  \"schedule\": \"0 9-17 * * *\"\n}\n```\n\n- `url` - datastores for various workflow and webhook URLs.\n\n```\n{\n  \"name\": \"triage_shortcut\",\n  \"url\": \"https://slack.com/shortcuts/unique_identifier\"\n}\n```\n\n- `done_emojis` - ddatastores for emojis that indicate a request is done, in\n  addition to the default list of emojis.\n\n```\n{\n  \"name\": \"red-x\"\n}\n```\n\n- `in_progress_emojis` - datastores for emojis that indicate a request is\n  currently being looked at in addition to the default list of emojis.\n\n```\n{\n  \"name\": \"eyes_right\"\n}\n```\n\n- `urgency_emojis` - datastores for emojis that indicate which messages is a\n  request, with their associated urgency levels. in addition to the default list\n  of emojis. **Note** that emojis are added in the format of :emoji: instead of\n  emoji.\n\n```\n{\n  \"name\": \":white-c:\",\n  \"urgency\": 2\n}\n```\n\nFor storing data related to your app, datastores offer secure storage on Slack\ninfrastructure. The use of a datastore requires the\n`datastore:write`/`datastore:read` scopes to be present in your manifest.\n\nYou may also intereact with datastores using the\n[Slack command line interface](https://api.slack.com/automation/cli/commands#datastore).\nInteracting datastores using the slack cli is examplified in workflow creations\nin [the Included Workflows section](#included-workflows).\n\n## Testing\n\nFor an example of how to test a function, see `functions/triage_test.ts`. Test\nfilenames should be suffixed with `_test`.\n\nRun all tests with `deno test`:\n\n```zsh\n$ deno test\n```\n\n## Deploying Your App\n\nOnce development is complete, deploy the app to Slack infrastructure using\n`slack deploy`:\n\n```zsh\n$ slack deploy\n```\n\nWhen deploying for the first time, you'll be prompted to\n[create a new link trigger](#creating-triggers) for the deployed version of your\napp. When that trigger is invoked, the workflow should run just as it did when\ndeveloping locally (but without requiring your server to be running).\n\n## Viewing Activity Logs\n\nActivity logs of your application can be viewed live and as they occur with the\nfollowing command:\n\n```zsh\n$ slack activity --tail\n```\n\n## Project Structure\n\n### `.slack/`\n\nContains `apps.dev.json` and `apps.json`, which include installation details for\ndevelopment and deployed apps.\n\n### `datastores/`\n\n[Datastores](https://api.slack.com/automation/datastores) securely store data\nfor your application on Slack infrastructure. Required scopes to use datastores\ninclude `datastore:write` and `datastore:read`.\n\n### `functions/`\n\n[Functions](https://api.slack.com/automation/functions) are reusable building\nblocks of automation that accept inputs, perform calculations, and provide\noutputs. Functions can be used independently or as steps in workflows.\n\n### `triggers/`\n\n[Triggers](https://api.slack.com/automation/triggers) determine when workflows\nare run. A trigger file describes the scenario in which a workflow should be\nrun, such as a user pressing a button or when a specific event occurs.\n\n### `workflows/`\n\nA [workflow](https://api.slack.com/automation/workflows) is a set of steps\n(functions) that are executed in order.\n\nWorkflows can be configured to run without user input or they can collect input\nby beginning with a [form](https://api.slack.com/automation/forms) before\ncontinuing to the next step.\n\n### `manifest.ts`\n\nThe [app manifest](https://api.slack.com/automation/manifest) contains the app's\nconfiguration. This file defines attributes like app name and description.\n\n### `slack.json`\n\nUsed by the CLI to interact with the project's SDK dependencies. It contains\nscript hooks that are executed by the CLI and implemented by the SDK.\n\n## Resources\n\nTo learn more about developing automations on Slack, visit the following:\n\n- [Automation Overview](https://api.slack.com/automation)\n- [CLI Quick Reference](https://api.slack.com/automation/cli/quick-reference)\n- [Samples and Templates](https://api.slack.com/automation/samples)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fdeno-triage-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fdeno-triage-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fdeno-triage-bot/lists"}