Skip to content

Commit

Permalink
intial working commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nitrag committed Sep 19, 2023
1 parent 44e5138 commit b910bbb
Show file tree
Hide file tree
Showing 16 changed files with 171 additions and 431 deletions.
2 changes: 2 additions & 0 deletions .example-env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
CHANNEL_ID="C00X00XXXXX"
AWS_REGION="us-east-1"
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
dist
package
.DS_Store
.slack/apps.dev.json
.slack/
.env
.vscode/
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
"editor.formatOnSave": true,
"editor.defaultFormatter": "denoland.vscode-deno"
},
"editor.tabSize": 2
"editor.tabSize": 2,
"nuxt.isNuxtApp": false
}
203 changes: 22 additions & 181 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,199 +1,40 @@
# Deno Starter Template
# Slack App: Amazon CloudWatch SNS (HTTPS)

This is a scaffolded Deno template used to build out Slack apps using the Slack
CLI.
This automation will provide a Webhook (HTTPS URL) which you can configure a SNS subscription
with, allowing Cloudwatch Alarms to be posted to your Slack Channel in a human
readable format.

**Guide Outline**:

- [Setup](#setup)
- [Install the Slack CLI](#install-the-slack-cli)
- [Clone the Template](#clone-the-template)
- [Running Your Project Locally](#running-your-project-locally)
- [Creating Triggers](#creating-triggers)
- [Datastores](#datastores)
- [Testing](#testing)
- [Deploying Your App](#deploying-your-app)
- [Viewing Activity Logs](#viewing-activity-logs)
- [Project Structure](#project-structure)
- [Resources](#resources)
*Please note that the features in this project requires that the workspace be part of
[a Slack paid plan](https://slack.com/pricing).*

---

## Setup

Before getting started, first make sure you have a development workspace where
you have permission to install apps. **Please note that the features in this
project require that the workspace be part of
[a Slack paid plan](https://slack.com/pricing).**

### Install the Slack CLI

To use this template, you need to install and configure the Slack CLI.
Step-by-step instructions can be found in our
To use this sample, you need to install and configure the Slack CLI. Step-by-step instructions can be found in our
[Quickstart Guide](https://api.slack.com/automation/quickstart).

### Clone the Template
### Deployment

Start by cloning this repository:

```zsh
# Clone this project onto your machine
$ slack create my-app -t slack-samples/deno-starter-template

# Change into the project directory
$ cd my-app
```

## Running Your Project Locally

While building your app, you can see your changes appear in your workspace in
real-time with `slack run`. You'll know an app is the development version if the
name has the string `(local)` appended.

```zsh
# Run app locally
$ slack run

Connected, awaiting events
```

To stop running locally, press `<CTRL> + C` to end the process.

## Creating Triggers

[Triggers](https://api.slack.com/automation/triggers) are what cause workflows
to run. These triggers can be invoked by a user, or automatically as a response
to an event within Slack.

When you `run` or `deploy` your project for the first time, the CLI will prompt
you to create a trigger if one is found in the `triggers/` directory. For any
subsequent triggers added to the application, each must be
[manually added using the `trigger create` command](#manual-trigger-creation).

When creating triggers, you must select the workspace and environment that you'd
like to create the trigger in. Each workspace can have a local development
version (denoted by `(local)`), as well as a deployed version. _Triggers created
in a local environment will only be available to use when running the
application locally._

### Link Triggers

A [link trigger](https://api.slack.com/automation/triggers/link) is a type of
trigger that generates a **Shortcut URL** which, when posted in a channel or
added as a bookmark, becomes a link. When clicked, the link trigger will run the
associated workflow.

Link triggers are _unique to each installed version of your app_. This means
that Shortcut URLs will be different across each workspace, as well as between
[locally run](#running-your-project-locally) and
[deployed apps](#deploying-your-app).

With link triggers, after selecting a workspace and environment, the output
provided will include a Shortcut URL. Copy and paste this URL into a channel as
a message, or add it as a bookmark in a channel of the workspace you selected.
Interacting with this link will run the associated workflow.

**Note: triggers won't run the workflow unless the app is either running locally
or deployed!**

### Manual Trigger Creation

To manually create a trigger, use the following command:

```zsh
$ slack trigger create --trigger-def triggers/sample_trigger.ts
```

## Datastores
# Install the Slack CLI and login
slack login

For storing data related to your app, datastores offer secure storage on Slack
infrastructure. For an example of a datastore, see
`datastores/sample_datastore.ts`. The use of a datastore requires the
`datastore:write`/`datastore:read` scopes to be present in your manifest.
# Create the App for your organization
slack create CloudWatch-SNS

## Testing
# Register the trigger (Required?)
slack trigger create --trigger-def "./triggers/webhook_trigger.ts"

For an example of how to test a function, see
`functions/sample_function_test.ts`. Test filenames should be suffixed with
`_test`.
# If you want to test locally:
# 1) create an `.env` file
# 2) Fill in the appropriate values for Channel ID and AWS Region
slack run

Run all tests with `deno test`:

```zsh
$ deno test
# Deploy and receive your webhook URL
slack deploy
# Register your CHANNEL_ID to send the notification to
slack env add CHANNEL_ID C00X00XXXXX
```

## Deploying Your App

Once development is complete, deploy the app to Slack infrastructure using
`slack deploy`:

```zsh
$ slack deploy
```

When deploying for the first time, you'll be prompted to
[create a new link trigger](#creating-triggers) for the deployed version of your
app. When that trigger is invoked, the workflow should run just as it did when
developing locally (but without requiring your server to be running).

## Viewing Activity Logs

Activity logs of your application can be viewed live and as they occur with the
following command:

```zsh
$ slack activity --tail
```

## Project Structure

### `.slack/`

Contains `apps.dev.json` and `apps.json`, which include installation details for
development and deployed apps.

### `datastores/`

[Datastores](https://api.slack.com/automation/datastores) securely store data
for your application on Slack infrastructure. Required scopes to use datastores
include `datastore:write` and `datastore:read`.

### `functions/`

[Functions](https://api.slack.com/automation/functions) are reusable building
blocks of automation that accept inputs, perform calculations, and provide
outputs. Functions can be used independently or as steps in workflows.

### `triggers/`

[Triggers](https://api.slack.com/automation/triggers) determine when workflows
are run. A trigger file describes the scenario in which a workflow should be
run, such as a user pressing a button or when a specific event occurs.

### `workflows/`

A [workflow](https://api.slack.com/automation/workflows) is a set of steps
(functions) that are executed in order.

Workflows can be configured to run without user input or they can collect input
by beginning with a [form](https://api.slack.com/automation/forms) before
continuing to the next step.

### `manifest.ts`

The [app manifest](https://api.slack.com/automation/manifest) contains the app's
configuration. This file defines attributes like app name and description.

### `slack.json`

Used by the CLI to interact with the project's SDK dependencies. It contains
script hooks that are executed by the CLI and implemented by the SDK.

## Resources

To learn more about developing automations on Slack, visit the following:

- [Automation Overview](https://api.slack.com/automation)
- [CLI Quick Reference](https://api.slack.com/automation/cli/quick-reference)
- [Samples and Templates](https://api.slack.com/automation/samples)
Binary file added assets/cloudwatch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/default_new_app_icon.png
Binary file not shown.
24 changes: 0 additions & 24 deletions datastores/sample_datastore.ts

This file was deleted.

72 changes: 0 additions & 72 deletions functions/sample_function.ts

This file was deleted.

27 changes: 0 additions & 27 deletions functions/sample_function_test.ts

This file was deleted.

Loading

0 comments on commit b910bbb

Please sign in to comment.