{"id":26289991,"url":"https://github.com/slack-samples/deno-triage-rotation","last_synced_at":"2025-05-07T22:44:02.542Z","repository":{"id":92141976,"uuid":"592419737","full_name":"slack-samples/deno-triage-rotation","owner":"slack-samples","description":"Create, manage, and delete rotation or on-call assignments","archived":false,"fork":false,"pushed_at":"2025-01-16T18:55:11.000Z","size":457,"stargazers_count":12,"open_issues_count":2,"forks_count":5,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-05-07T22:43:58.711Z","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-01-23T17:37:34.000Z","updated_at":"2025-01-20T09:57:40.000Z","dependencies_parsed_at":"2023-10-25T19:34:37.157Z","dependency_job_id":"fbec8f3b-2a8c-4a40-94dd-20d74807160b","html_url":"https://github.com/slack-samples/deno-triage-rotation","commit_stats":null,"previous_names":[],"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-rotation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-rotation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-rotation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-triage-rotation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/deno-triage-rotation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252967974,"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:35.420Z","updated_at":"2025-05-07T22:44:02.521Z","avatar_url":"https://github.com/slack-samples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Triage Rotation\n\nThis automation allows users to create, manage, and delete rotation or on-call\nassignments. This app uses datastores to store rotations on a per-channel basis.\n\n![deno-triage-rotation](https://user-images.githubusercontent.com/55667998/215822815-8555fdb2-694a-4799-b9fc-59670519ae6e.gif)\n\n**Guide Outline**:\n\n- [Included Workflows](#included-workflows)\n- [Setup](#setup)\n  - [Install the Slack CLI](#install-the-slack-cli)\n  - [Clone the Template](#clone-the-template)\n- [Running Your Project Locally](#running-your-project-locally)\n- [Creating Triggers](#creating-triggers)\n- [Workflow Usage](#workflow-usage)\n  - [Manage Rotation](#manage-rotation)\n  - [Advance Rotation](#advance-rotation)\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## Included Workflows\n\n- **Manage rotation**: Create, manage, or delete an existing rotation. This\n  workflow is triggered by a shortcut.\n- **Advance rotation**: Updates the rotation to the latest, notifies users. This\n  workflow is triggered by a schedule.\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 template, 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 Template\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-rotation\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## Creating Triggers\n\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).\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/manage_rotation.ts\n```\n\n## Workflow Usage\n\nAdd your app to the same channel where the link trigger was shared. You can do\nthis by @mentioning the app directly in a message in the channel.\n\n### Manage Rotation\n\nWith your app running locally (`slack run`), click the link trigger that you\nshared in your Slack workspace. The workflow's first step, an input form, will\nappear where you can complete the required fields to create a rotation for the\nchannel where you triggered the worklow.\n\nIf a rotation belonging to the channel already exists, the form will show\ndetails about the rotation and allow you to edit those fields.\n\nAfter you submit the form, the next step in the workflow creates a rotation and\ncreates a scheduled trigger for workflow #2: Advance Rotation.\n\nTo check whether your rotation has been created, just trigger the workflow from\nthe channel again and look at the existing rotation details. You can also delete\nan existing rotation from this form.\n\n### Advance Rotation\n\nThis workflow is triggered by a scheduled trigger created in a step in the\nearlier workflow. This workflow notifies the current rotation assignee in the\nchannel and then advances the rotation.\n\n:bulb: This app comes set up with a `.env` file and the ability to turn on a\n`debugMode` to give you a bit more control on when _Advance Rotation_ (see,\n`workflows/advance_rotation.ts`) is triggered. This is helpful for debugging.\n\n## Datastores\n\nFor storing data related to your app, datastores offer secure storage on Slack\ninfrastructure. For an example of a datastore, see `datastores/rotations.ts`.\nThe use of a datastore requires the `datastore:write`/`datastore:read` scopes to\nbe present in your manifest.\n\n## Testing\n\nTest filenames 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-rotation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fdeno-triage-rotation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fdeno-triage-rotation/lists"}