Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crazymanish/fastlane-plugin-slack_bot

A Fastlane plugin to customize your automation workflow(s) with a Slack Bot 🤖🚀
https://github.com/crazymanish/fastlane-plugin-slack_bot

bot bot-api fastlane fastlane-plugins slack

Last synced: 10 days ago
JSON representation

A Fastlane plugin to customize your automation workflow(s) with a Slack Bot 🤖🚀

Host: GitHub
URL: https://github.com/crazymanish/fastlane-plugin-slack_bot
Owner: crazymanish
License: mit
Created: 2020-05-27T17:22:53.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-05-29T12:22:01.000Z (over 1 year ago)
Last Synced: 2024-04-24T15:13:27.418Z (7 months ago)
Topics: bot, bot-api, fastlane, fastlane-plugins, slack
Language: Ruby
Homepage:
Size: 60.5 KB
Stars: 38
Watchers: 1
Forks: 5
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## Fastlane `slack_bot` plugin

[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-slack_bot)
![![License]](https://img.shields.io/badge/license-MIT-green.svg?style=flat)
[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-slack_bot.svg)](https://badge.fury.io/rb/fastlane-plugin-slack_bot)
[![Twitter: @manish](https://img.shields.io/badge/[email protected]?style=flat)](https://twitter.com/iammanishrathi)

A fastlane plugin to customize your automation workflow(s) with a **Slack Bot** 🤖 using the [Slack APIs](https://api.slack.com/)

- [About](#about)
- [Getting Started](#getting-started)
- [Features](#features)
- [Post a message](#examples-post-a-message) examples
- [Update a message](https://github.com/crazymanish/fastlane-plugin-slack_bot/blob/master/lib/fastlane/plugin/slack_bot/actions/update_slack_message.rb#L115) examples
- [Delete a message](https://github.com/crazymanish/fastlane-plugin-slack_bot/blob/master/lib/fastlane/plugin/slack_bot/actions/delete_slack_message.rb#L78) examples
- [Upload a file](#examples-upload-a-message) examples
- [About Fastlane](#about-fastlane)

## About

A fastlane plugin to post slack message and much more using Slack bot api token. 🚀\
**Note:** `Fastlane` comes with built-in `slack` action by default, which uses slack webhook url and have webhook limitations.
i.e Listing couple of slack **webhook url** limitations:
- can't post a direct message to a slack user.
- can’t post a message inside a slack thread.
- can’t update a posted slack message.
- can’t list and upload a file inside a slack channel.
- many more, compare to a **Slack Bot** 🤖 using the [Slack APIs](https://api.slack.com/)

## Getting Started

1. [Generate `Slack token` for `Fastlane` bot](https://slack.com/intl/en-nl/help/articles/115005265703-Create-a-bot-for-your-workspace)
- Add a slack `Bot` user
- Choose a name for your bot, e.g. `"fastlane"`
- Save `API Token`

2. Add plugin in your project

```bash
fastlane add_plugin slack_bot
```
If you are using fastlane using Gemfile in your project, add it to your project by running:
```bash
bundle exec fastlane add_plugin slack_bot
```

3. Use `slack_bot` features inside your lane in `Fastfile` whenever you want.

## Features
Using this `slack_bot` plugin, you can:

- Post a message using [chat.postMessage](https://api.slack.com/methods/chat.postMessage) Slack API
- [x] Post a message to a _public_ channel
- [x] Post a message to a _private_ channel
- [x] Post a message to a _slack user_ (DM)
- [x] Post a message inside a _slack thread_ 🧵
- [x] Post a message with _custom Bot username and icon_

- Update a message using [chat.update](https://api.slack.com/methods/chat.update) Slack API
- [x] update a message in a channel

- Delete a message using [chat.delete](https://api.slack.com/methods/chat.delete) Slack API
- [x] delete a message in a channel

- List of files in a channel using [files.list](https://api.slack.com/methods/files.list) Slack API
- [x] A list of files in a channel, It can be filtered and sliced in various ways.

- Upload a file using [files.upload](https://api.slack.com/methods/files.upload) Slack API
- [x] Upload a file to a _public_ channel
- [x] Upload a file to a _private_ channel
- [x] Upload a file to a _slack user_ (DM)
- [x] Upload a file inside a _slack thread_ 🧵
- [x] Upload a file with _multiple channels/users_

## Examples (Post a message)

Let’s post a message to the default slack bot channel.

```ruby
# share on Slack
post_to_slack(message: "App successfully released!")
```

Let’s post a direct message to a slack user that unit tests CI has been failed.

```ruby
# share on Slack
post_to_slack(
message: "CI: Your unit tests on #{ENV['CI_COMMIT_REF_NAME']} failed",
channel: "@SlackUsername" # This can be Slack userID, instead of username i.e @UXXXXX
)
```

Let’s post a slack message to the `#ios-team` channel about the new test-flight build.

```ruby
lane :beta do
gym # Build the app and create .ipa file
pilot # Upload build to TestFlight

version_number = get_version_number # Get project version
build_number = get_build_number # Get build number
beta_release_name = "#{version_number}-#{build_number}-beta-release"

# share on Slack
post_to_slack(
message: "Hi team, we have a new test-flight beta build: #{beta_release_name}",
channel: "#ios-team"
)
end
```

Let’s post a slack message with custom payload.

```ruby
# share on Slack
post_to_slack(
api_token: "xyz", # Preferably configure as ENV['SLACK_API_TOKEN']
message: "App successfully released!",
channel: "#channel", # Optional, by default will post to the default channel configured for the Slack Bot.
success: true, # Optional, defaults to true.
payload: { # Optional, lets you specify any number of your own Slack attachments.
"Build Date" => Time.new.to_s,
"Built by" => "Jenkins",
},
default_payloads: [:git_branch, :git_author], # Optional, lets you specify an allowlist of default payloads to include. Pass an empty array to suppress all the default payloads.
# Don't add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit`, `last_git_commit_hash`.
attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
# This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
thumb_url: "http://example.com/path/to/thumb.png",
fields: [{
title: "My Field",
value: "My Value",
short: true
}]
}
)
```

Let’s post a slack message inside a slack thread 🧵

```ruby
lane :release do
# Start the release with slack release thread
release_thread = post_to_slack(
message: "Good morning team, CI has started the AppStore release. You can find more information inside this thread 🧵",
channel: "#ios-team"
)

# Important: Save this slack thread timestamp for futher slack messages
release_thread_ts = release_thread[:json]["ts"]

gym # Build the app and create .ipa file

# Post an update in release thread
post_to_slack(
message: "App has been build successfully! 💪",
channel: "#ios-team",
thread_ts: release_thread_ts
)

deliver # Upload build to AppStore

# Post an update in release thread
post_to_slack(
message: "App has been uploaded to the AppStore and submitted for Apple's review! 🚀",
channel: "#ios-team",
thread_ts: release_thread_ts
)
end
```

Let’s post a message with custom slack bot username and icon

```ruby
# share on Slack
post_to_slack(
message: "App successfully released!",
username: "Release Bot", # Overrides the bot's username
icon_url: "https://fastlane.tools/assets/img/fastlane_icon.png" # Overrides the bot's icon
)
```

## Examples (Upload a file)

Let’s Upload a file to a slack channel that main branch unit tests has been failed, see scan logs.

```ruby
# File upload on Slack
file_upload_to_slack(
initial_comment: "CI: main-branch unit tests failed",
file_path: "scan.log",
channels: "#ios-team" # Comma-separated list of slack #channel names where the file will be shared
)
```

Let’s Upload a file to a slack user that your branch unit tests has been failed, see scan logs.

```ruby
# File upload on Slack
file_upload_to_slack(
initial_comment: "CI: Your unit tests on #{ENV['CI_COMMIT_REF_NAME']} failed",
file_path: "scan.log",
channels: "@SlackUsername" # This can be Slack userID, instead of username i.e @UXXXXX
)
```

Let’s Upload a file inside a slack thread 🧵

# Important: Save this slack thread timestamp for futher slack messages
release_thread_ts = release_thread[:json]["ts"]

gym # Build the app and create .ipa file

# Post an update in release thread
post_to_slack(
message: "App has been build successfully! 💪",
channel: "#ios-team",
thread_ts: release_thread_ts
)

deliver # Upload build to AppStore

# Post an update in release thread
post_to_slack(
message: "App has been uploaded to the AppStore and submitted for Apple's review! 🚀",
channel: "#ios-team",
thread_ts: release_thread_ts
)

# Spaceship logs file upload on Slack
file_upload_to_slack(
initial_comment: "Deliver:: Spaceship logs",
file_path: "spaceship.log",
channels: "#ios-team",
thread_ts: release_thread_ts
)
end
```

## About Fastlane

_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).