Skip to main content

Logger for Slack

Latest docshttps://samcarey.dev/docs/Unity/build-assistant/Plugins/Build_Assistant_Slack

Display name
Build Assistant Logger for Slack
Package
dev.samcarey.buildassistant.plugin-slack

Posts build status using the Slack API.

Slack build log message

Install​

This plugin is a UPM package. It is not downloaded from this site.

  1. Open WindowPackage Manager.
  2. Select My Assets.
  3. Find Build Assistant Logger for Slack.
  4. Click Install or Add.

The core package dev.samcarey.buildassistant.core must already be in the project.

Setup​

The Slack logger is enabled from Project Settings. You do not add it as an action on a build config.

Create a Slack app​

  1. Open the Slack API apps page and click Create New App.
  2. Choose Blank app. Name the app and pick the workspace that should receive build logs.
  3. Open OAuth & Permissions.
  4. Under Bot Token Scopes, add:
    • chat:write
    • chat:write.public
    • files:write
  5. Click Install to Workspace and allow the app.

Add it in Unity​

  1. Open Project SettingsBuild AssistantLogger for Slack.
  2. Add a workspace: set an ID, Slack Channel ID, and Slack Token.
  3. Set the default workspace and leave Slack Logger Enabled on.

Usage​

The Slack logger sends build progress updates, error notifications, and build reports to your configured Slack channel. Supports multiple workspaces and per-configuration channel routing.

Command-line args​

The Slack plugin supports these batch launch argument overrides:

  • WithSlackLogger - Enable or disable Slack logger (true or false)
  • Agent - Display agent name in Slack logs. Useful when running builds on CI with multiple agents (cosmetic only)
  • SlackWorkspace - Use a workspace template set in settings
  • SlackToken and SlackChannel - Use a specific token and channel ID (use together as an alternative to SlackWorkspace)
  • SlackParentTS - Timestamp returned from the Slack API. If provided, all logs will be placed as a reply to this message. Usually used when running multiple configs (e.g., build configs for each platform)

Use SlackWorkspace, or SlackToken and SlackChannel. Do not mix the two.

-WithSlackLogger true -Agent "CI-Agent-01" -SlackWorkspace "workspace_name"
-WithSlackLogger true -Agent "CI-Agent-01" -SlackToken "xoxb-token" -SlackChannel "channel_id"

Third-party software​

Asset uses Newtonsoft.Json under MIT; see Third-Party Notices.txt file in package for details.