Adds Slack integration to boardwalkd through means of a Slack App, such that it is now possible to quickly view the status of workspaces--along with the logged events--as well as catch or release workspaces from within Slack. This is intended to augment--not replace--the web dashboard.
Using the Slack app manifest located within slack_app_manifest.yaml, an individual implementing Boardwalk can quickly conmfigure the required settings for the app. Additional configuration, if desired, may be done after--or before by directly editing the manifest--the app is created within Slack's
system.
Using this feature is done by providing a Slack app and bot token, in the BOARDWALKD_SLACK_APP_TOKEN and BOARDWALKD_SLACK_BOT_TOKEN environment variables.
Features provided by this integration include:
A Slack app home page, which displays at a glance statuses for configured workspaces
The ability to catch or release one, multiple, or all workspaces.
Viewing the details of a specified workspace.
Adds the following Slack slash-commands: - /brdwlk-version - Returns the currently running version of Boardwalk. - /brdwlk-catch-release - Allows one or more workspaces to be caught or released from a single modal. - /brdwlk-list - Lists workspaces with an active worker
What and why?
How was this tested?
Checklist
[x] Have you updated the version in the [tool.poetry] section of
the pyproject.toml file (if applicable)?
Yes, but this is also currently in development/testing; based on how the testing environment is set up requires an intermediate step of the rc.0, however once verified as working on the real Slack instance in the test environment, the version will be updated to drop the release candidate version segment.
Adds Slack integration to
boardwalkdthrough means of a Slack App, such that it is now possible to quickly view the status of workspaces--along with the logged events--as well as catch or release workspaces from within Slack. This is intended to augment--not replace--the web dashboard.Using the Slack app manifest located within
slack_app_manifest.yaml, an individual implementing Boardwalk can quickly conmfigure the required settings for the app. Additional configuration, if desired, may be done after--or before by directly editing the manifest--the app is created within Slack's system.Using this feature is done by providing a Slack app and bot token, in the
BOARDWALKD_SLACK_APP_TOKENandBOARDWALKD_SLACK_BOT_TOKENenvironment variables.Features provided by this integration include:
/brdwlk-version- Returns the currently running version of Boardwalk. -/brdwlk-catch-release- Allows one or more workspaces to be caught or released from a single modal. -/brdwlk-list- Lists workspaces with an active workerWhat and why?
How was this tested?
Checklist
versionin the[tool.poetry]section of thepyproject.tomlfile (if applicable)?rc.0, however once verified as working on the real Slack instance in the test environment, the version will be updated to drop the release candidate version segment.