{"id":26289968,"url":"https://github.com/slack-samples/deno-announcement-bot","last_synced_at":"2025-07-08T01:14:52.347Z","repository":{"id":114488765,"uuid":"572987459","full_name":"slack-samples/deno-announcement-bot","owner":"slack-samples","description":"Preview, post, and manage announcements sent to one or more channels","archived":false,"fork":false,"pushed_at":"2025-01-16T18:57:24.000Z","size":431,"stargazers_count":42,"open_issues_count":1,"forks_count":18,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-31T15:00:04.392Z","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":"2022-12-01T13:12:09.000Z","updated_at":"2025-03-14T16:41:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"dcaa0954-3b88-4550-9797-2cb52be0ae9b","html_url":"https://github.com/slack-samples/deno-announcement-bot","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-announcement-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-announcement-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-announcement-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slack-samples%2Fdeno-announcement-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slack-samples","download_url":"https://codeload.github.com/slack-samples/deno-announcement-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:30.953Z","updated_at":"2025-07-08T01:14:52.340Z","avatar_url":"https://github.com/slack-samples.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Announcement Bot\n\nThis sample automation helps users draft, edit, and send announcements to one or\nmore channels.\n\nhttps://user-images.githubusercontent.com/55667998/211395878-8b261c76-ba7d-4d3f-b7b5-07cbd44efffd.mp4\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 Sample](#clone-the-sample)\n- [Running Your Project Locally](#running-your-project-locally)\n- [Creating Triggers](#creating-triggers)\n  - [Usage](#usage)\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- **Create announcement**: Create an announcement draft and later edit or send\n  it to selected channels\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\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-announcement-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## 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/create_announcement.ts\n```\n\n### Usage\n\nWith your app running locally, click the link trigger that you shared in your\nSlack workspace. The workflow's first step, an input form, will appear where you\ncan completed the required fields.\n\nIf you'd like, you can compose an announcement using\n[Block Kit Builder](https://app.slack.com/block-kit-builder) instead of plain\ntext or [mrkdwn](https://api.slack.com/reference/surfaces/formatting). Tip: Use\nthe \"Copy Payload\" button to copy your Block Kit directly to your clipboard.\n\nHere is the format of the blocks that the app expects:\n\n```json\n{\n  \"blocks\": [\n    {\n      \"type\": \"section\",\n      \"text\": {\n        \"type\": \"mrkdwn\",\n        \"text\": \"_This_ is an *important* announcement!\"\n      }\n    }\n  ]\n}\n```\n\nSubmitting the form will post the message and other details to the draft channel\nyou provided.\n\n\u003e :bulb: Please note that interactive elements (such as buttons, dropdowns) etc.\n\u003e are not supported.\n\nUse the overflow menu found in the draft message to edit the announcement text.\nOnce ready, click the **Send Announcement** button to post the announcement in\neach channel you previously provided in the form.\n\nOnce sent, the draft message in channel will be updated and a summary (with\nlinks) will be posted to the thread.\n\n### Notes\n\n- Private channels, DM, and MPDMs are not supported in either the destination\n  channels or the draft channel select menus in the\n  [OpenForm](https://api.slack.com/automation/functions#open-a-form) built-in\n  function.\n- A common reason an announcement might fail to send to a destination channel is\n  that\n  [posting has been restricted](https://slack.com/help/articles/360004635551)\n  (`restricted_action` error). Give your app explicit permission to post using\n  the channel settings if necessary.\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\n`datastores/announcements.ts`. The use of a datastore requires the\n`datastore:write`/`datastore:read` scopes to be present in your manifest.\n\n## Testing\n\nFor an example of how to test a function, see\n`functions/create_draft/handler_test.ts`. Test filenames should be suffixed with\n`_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\nContains `hooks.json` used by the CLI to interact with the project's SDK\ndependencies. It contains script hooks that are executed by the CLI and\nimplemented by the SDK.\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## 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-announcement-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslack-samples%2Fdeno-announcement-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslack-samples%2Fdeno-announcement-bot/lists"}