Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seratch/slack-cli-gh-actions-demo
Demonstrating Slack CLI Deployment Using GitHub Actions
https://github.com/seratch/slack-cli-gh-actions-demo
automation deno denoland slack typescript workflow workflows
Last synced: 3 months ago
JSON representation
Demonstrating Slack CLI Deployment Using GitHub Actions
- Host: GitHub
- URL: https://github.com/seratch/slack-cli-gh-actions-demo
- Owner: seratch
- License: mit
- Created: 2023-10-24T06:33:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-06T21:14:57.000Z (about 1 year ago)
- Last Synced: 2024-08-25T00:53:08.514Z (5 months ago)
- Topics: automation, deno, denoland, slack, typescript, workflow, workflows
- Language: TypeScript
- Homepage: https://api.slack.com/automation
- Size: 364 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Demonstrating Slack CLI Deployment Using GitHub Actions
This tutorial provides guidance on setting up a Slack CLI project to facilitate automatic deployments when code modifications are pushed into the main branch.
## Create a GitHub repo
Let's start by creating a blank GitHub repository for this automation. Feel free to use any name you desire for it, and you don't need to add any files at this time.
## Install Slack's CLI
Before you enable automated deployments, it is necessary to execute several Slack CLI commands on your local machine.
Therefore, you should install the CLI in your terminal.
The following command will install the CLI if you are working on macOS or Linux.
For other platforms, step-by-step instructions can be found in the [Quickstart Guide](https://api.slack.com/automation/quickstart).
```bash
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
```
If you're using the CLI for the first time, you must connect the CLI to your Slack workspace in order to deploy your automation workflows. Execute the `slack login` command, you will then be prompted to run a slash command named `/slackauthticket` with an argument in a Slack workspace/organization as below. Copy this command and run it in the Slack workspace/organization where you wish to install this app.
```
$ slack login
📋 Run the following slash command in any Slack channel or DM
This will open a modal with user permissions for you to approve
Once approved, a challege code will be generated in Slack
/slackauthticket MTlkOTg4OWUtOTI5My00N2E3LWJhN2QtNzJmZWM1NDVlM2E5
? Enter challenge code
```
Once you've finished the login process, let's make sure if there are no issues with the installation. You can execute the `slack doctor` command for it. If everything is fine, you will see `Errors: 0` at the bottom of the output.
## Create a new app
Run `slack create` command to generate a new Slack app project:
```
$ slack create gh-actions-demo
? Select a template to build from: [Use arrows to move]
❱ Issue submission (default sample)
Basic app that demonstrates an issue submission workflow
Scaffolded template
Solid foundation that includes a Slack datastore
Blank template
A, well.. blank project
View more samples
Guided tutorials can be found at api.slack.com/automation/samples
```
Select the default sample (Issue submissions) this time:
```
$ slack create gh-actions-demo
? Select a template to build from: Issue submission (default sample)
⚙️ Creating a new Slack app in ~/my-awesome-repo/gh-actions-demo
📦 Installed project dependencies
✨ gh-actions-demo successfully created
🧭 Explore the documentation to learn more
Read the README.md or peruse the docs over at api.slack.com/automation
Find available commands and usage info with slack help
📋 Follow the steps below to begin development
Change into your project directory with cd gh-actions-demo/
Develop locally and see changes in real-time with slack run
When you're ready to deploy for production use slack deploy
```
## Deploy the app
Let's deploy this app into your Slack workspace/organization.
You can run `slack deploy` command for it:
```
$ slack deploy
? Choose a deployed environment Install to a new workspace or organization
? Install to a new workspace or organization acme-corp T03E94MJU
🔔 If you leave this workspace or organization, you can no longer manage the installed apps
Installed apps will belong to the workspace or organization if you leave the workspace
📚 App Manifest
Created app manifest for "gh-actions-demo" in "Acme Corp"
🏠 App Install
Installing "gh-actions-demo" app to "Acme Corp"
Updated app icon: assets/default_new_app_icon.png
Finished in 4.6s
⚡ Listing triggers installed to the app...
There are no triggers installed for the app
⚡ Create a trigger
Searching for trigger definition files under 'triggers/*'...
Found 1 trigger definition file
? Choose a trigger definition file: triggers/submit_issue.ts
⚡ Trigger successfully created!
Submit an issue Ft********** (shortcut)
Created: 2023-10-24 15:45:50 +09:00 (1 second ago)
Collaborators:
Kaz Sera @seratch U03E94MK0
Can be found and used by:
everyone in the workspace
https://slack.com/shortcuts/Ft**********/36f28af0a74b********************
🎁 App packaged and ready to deploy
0.016MB was packaged in 0.4s
🚀 gh-actions-demo deployed in 8.6s
Dashboard: https://slack.com/apps/A062VA*****
App Owner: seratch (U03E94MK0)
Workspace: Acme Corp (T03E94MJU)
🌩 Visit your workspace or organization to try out your live app!
When you make any changes, update your app by re-running slack deploy
💌 We would love to know how things are going
Survey your development experience with slack feedback --name platform-improvements
```
During the process, you will be prompted to create a link trigger.
You can create it this time. Copy the `slack.com` URL and share it in a Slack channel or on a canvas document.
You will see a button to start the workflow:
Click the button to verify if your workflow is functioning properly.
If it is indeed operating as expected, that implies your initial (though manual) deployment has been successful!
## Obtain the app's service token
To automate the deployment, you need to acquire this app's service token to execute the `slack deploy` command without requiring any interactions on the terminal window.
Go to the root directory of the project and run the `slack auth token` command as illustrated below. Similar to what you did for the `slack login` command, you will then be prompted to run a slash command named `/slackauthticket` with an argument. Copy the command and run it in Slack.
```
$ cd gh-actions-demo/
$ slack auth token
📋 Run the following slash command in any Slack channel or DM
This will open a modal with user permissions for you to approve
Once approved, a challege code will be generated in Slack
/slackauthticket N2JkOGVjZDAtMTRhZC00NmUwLThjNj******************
? Enter challenge code
```
You will be given a challenge code, which could be a random string such as `iBz5TFyc`.
Input this code in the terminal. You will see a service token (xoxp-...) appearing in the output:
```
$ slack auth token
📋 Run the following slash command in any Slack channel or DM
This will open a modal with user permissions for you to approve
Once approved, a challege code will be generated in Slack
/slackauthticket N2JkOGVjZDAtMTRhZC00NmUwLThjNj******************
? Enter challenge code iBz5TFyc
✅ You've successfully authenticated! 🎉
Service token:
xoxp-1563*********-1556*********-6081*********-0a32e593af6370******************
Make sure to copy the token now and save it safely.
💡 Get started by creating a new app with slack create my-app
Explore the details of available commands with slack help
```
You remember you've created a new GitHub repo as the first step. Head to the repo's settings page **Security** > **Secrets and variables** > **Actions** and click the "New repository secret" button to add a new secret:
* Name: SLACK_SERVICE_TOKEN
* Secret: the `xoxp-` prefixed service token string you've obtained in the preivous step
## Add a GH Actions workflow for deploying the app
Add a new file `.github/workflows/deployment.yml` with the following content:
```yaml
name: Slack App Deployment
# Deploy the latest revision of this repo to Slack platform when:
on:
push:
branches: [ main ]
jobs:
build:
# You can go with any other Linux options if you prefer
runs-on: ubuntu-latest
# The deployment process itself usually takes less than 1 minute
# When your app's code base is larger in the future, you may want to adjust this duration
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
# Slack CLI requires Deno runtime
- name: Install Deno runtime
uses: denoland/setup-deno@v1
with:
# Using the latest stable version along with Slack CLI is recommend
deno-version: v1.x
- name: Cache Slack CLI installation
id: cache-slack
uses: actions/cache@v3
with:
path: |
/usr/local/bin/slack
~/.slack/bin/slack
key: ${{ runner.os }}-slack
- name: Install Slack CLI
if: steps.cache-slack.outputs.cache-hit != 'true'
run: |
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
- name: Deploy the app
env:
# you can obtain this token string (xoxp-...) by running `slack auth token`
# Note that this token is connected to a specific Slack workspace/org
SLACK_SERVICE_TOKEN: ${{ secrets.SLACK_SERVICE_TOKEN }}
run: |
# If you place the code in the top directory, there's no need to use this command
cd gh-actions-demo/
slack deploy -s --token $SLACK_SERVICE_TOKEN
```
## Push commits to main branch
Push the changes into the main branch and see how it goes.
If the GitHub Actions job successfully completes, your app is now available in the Slack workspace :tada:
## Wrap up
Here are the steps you've learned through this tutorial:
* Create a new GitHub repository
* Create a new Slack app using the `slack create` command
* Manually deploy the app using `slack deploy` command on your local machine
* Obtain a service token for a Slack workspace/organization
* Add the service token to the GitHub repository as a secret
* Add GitHub Actions workflow to automate deployments using `slack deploy` with the service token
Your GitHub repository is now set up for team collaboration! Your team members can review code changes by submitting PRs, and once these are merged into the main branch, the changes will be deployed automatically, requiring no manual operations. Should you need to reverse a deployment, you can create a reverting PR and quickly merge that.
Enjoy building workflows using Slack's automation platform!