Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Block Kit for slack messages #1815

Merged
merged 13 commits into from Mar 2, 2021
Merged

Use Block Kit for slack messages #1815

merged 13 commits into from Mar 2, 2021

Conversation

hipstersmoothie
Copy link
Collaborator

@hipstersmoothie hipstersmoothie commented Feb 18, 2021

What Changed

See title

Why

  • Richer messages
  • Code snippets
  • Multiple channels

Todo:

  • Add tests
  • Add docs

Change Type

Indicate the type of change your pull request is:

  • documentation
  • patch
  • minor
  • major

🐤 Download canary assets:

auto-linux-canary.1815.22355.gz
auto-macos-canary.1815.22355.gz
auto-win.exe-canary.1815.22355.gz

📦 Published PR as canary version: under canary scope @auto-canary@10.17.0-canary.1815.22355.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@10.17.0-canary.1815.22355.0
npm install @auto-canary/auto@10.17.0-canary.1815.22355.0
npm install @auto-canary/core@10.17.0-canary.1815.22355.0
npm install @auto-canary/package-json-utils@10.17.0-canary.1815.22355.0
npm install @auto-canary/all-contributors@10.17.0-canary.1815.22355.0
npm install @auto-canary/brew@10.17.0-canary.1815.22355.0
npm install @auto-canary/chrome@10.17.0-canary.1815.22355.0
npm install @auto-canary/cocoapods@10.17.0-canary.1815.22355.0
npm install @auto-canary/conventional-commits@10.17.0-canary.1815.22355.0
npm install @auto-canary/crates@10.17.0-canary.1815.22355.0
npm install @auto-canary/docker@10.17.0-canary.1815.22355.0
npm install @auto-canary/exec@10.17.0-canary.1815.22355.0
npm install @auto-canary/first-time-contributor@10.17.0-canary.1815.22355.0
npm install @auto-canary/gem@10.17.0-canary.1815.22355.0
npm install @auto-canary/gh-pages@10.17.0-canary.1815.22355.0
npm install @auto-canary/git-tag@10.17.0-canary.1815.22355.0
npm install @auto-canary/gradle@10.17.0-canary.1815.22355.0
npm install @auto-canary/jira@10.17.0-canary.1815.22355.0
npm install @auto-canary/magic-zero@10.17.0-canary.1815.22355.0
npm install @auto-canary/maven@10.17.0-canary.1815.22355.0
npm install @auto-canary/microsoft-teams@10.17.0-canary.1815.22355.0
npm install @auto-canary/npm@10.17.0-canary.1815.22355.0
npm install @auto-canary/omit-commits@10.17.0-canary.1815.22355.0
npm install @auto-canary/omit-release-notes@10.17.0-canary.1815.22355.0
npm install @auto-canary/pr-body-labels@10.17.0-canary.1815.22355.0
npm install @auto-canary/released@10.17.0-canary.1815.22355.0
npm install @auto-canary/s3@10.17.0-canary.1815.22355.0
npm install @auto-canary/slack@10.17.0-canary.1815.22355.0
npm install @auto-canary/twitter@10.17.0-canary.1815.22355.0
npm install @auto-canary/upload-assets@10.17.0-canary.1815.22355.0
npm install @auto-canary/vscode@10.17.0-canary.1815.22355.0
# or 
yarn add @auto-canary/bot-list@10.17.0-canary.1815.22355.0
yarn add @auto-canary/auto@10.17.0-canary.1815.22355.0
yarn add @auto-canary/core@10.17.0-canary.1815.22355.0
yarn add @auto-canary/package-json-utils@10.17.0-canary.1815.22355.0
yarn add @auto-canary/all-contributors@10.17.0-canary.1815.22355.0
yarn add @auto-canary/brew@10.17.0-canary.1815.22355.0
yarn add @auto-canary/chrome@10.17.0-canary.1815.22355.0
yarn add @auto-canary/cocoapods@10.17.0-canary.1815.22355.0
yarn add @auto-canary/conventional-commits@10.17.0-canary.1815.22355.0
yarn add @auto-canary/crates@10.17.0-canary.1815.22355.0
yarn add @auto-canary/docker@10.17.0-canary.1815.22355.0
yarn add @auto-canary/exec@10.17.0-canary.1815.22355.0
yarn add @auto-canary/first-time-contributor@10.17.0-canary.1815.22355.0
yarn add @auto-canary/gem@10.17.0-canary.1815.22355.0
yarn add @auto-canary/gh-pages@10.17.0-canary.1815.22355.0
yarn add @auto-canary/git-tag@10.17.0-canary.1815.22355.0
yarn add @auto-canary/gradle@10.17.0-canary.1815.22355.0
yarn add @auto-canary/jira@10.17.0-canary.1815.22355.0
yarn add @auto-canary/magic-zero@10.17.0-canary.1815.22355.0
yarn add @auto-canary/maven@10.17.0-canary.1815.22355.0
yarn add @auto-canary/microsoft-teams@10.17.0-canary.1815.22355.0
yarn add @auto-canary/npm@10.17.0-canary.1815.22355.0
yarn add @auto-canary/omit-commits@10.17.0-canary.1815.22355.0
yarn add @auto-canary/omit-release-notes@10.17.0-canary.1815.22355.0
yarn add @auto-canary/pr-body-labels@10.17.0-canary.1815.22355.0
yarn add @auto-canary/released@10.17.0-canary.1815.22355.0
yarn add @auto-canary/s3@10.17.0-canary.1815.22355.0
yarn add @auto-canary/slack@10.17.0-canary.1815.22355.0
yarn add @auto-canary/twitter@10.17.0-canary.1815.22355.0
yarn add @auto-canary/upload-assets@10.17.0-canary.1815.22355.0
yarn add @auto-canary/vscode@10.17.0-canary.1815.22355.0

@adierkens adierkens added the minor Increment the minor version when merged label Feb 18, 2021
plugins/slack/README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 18, 2021

Codecov Report

Merging #1815 (6210899) into main (b46cac1) will increase coverage by 0.05%.
The diff coverage is 80.68%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1815      +/-   ##
==========================================
+ Coverage   80.16%   80.21%   +0.05%     
==========================================
  Files          64       64              
  Lines        4997     5121     +124     
  Branches     1154     1194      +40     
==========================================
+ Hits         4006     4108     +102     
- Misses        672      686      +14     
- Partials      319      327       +8     
Impacted Files Coverage Δ
plugins/slack/src/index.ts 78.74% <69.56%> (-7.38%) ⬇️
plugins/microsoft-teams/src/index.ts 84.05% <89.65%> (+25.23%) ⬆️
packages/core/src/validate-config.ts 91.60% <94.44%> (+0.37%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b46cac1...6210899. Read the comment docs.

@hipstersmoothie hipstersmoothie merged commit 2e8e07e into main Mar 2, 2021
@hipstersmoothie hipstersmoothie deleted the slack-upgrade branch March 2, 2021 18:24
@adierkens
Copy link
Collaborator

🚀 PR was released in v10.17.0 🚀

@adierkens adierkens added the released This issue/pull request has been released. label Mar 2, 2021
@reintroducing
Copy link

@hipstersmoothie I have a suggestion around the docs for the Slack plugin. I think it would be helpful to show a screenshot of the output in Slack that the plugin provides. We actually wrote our own Slack plugin because we did not like how the prior version looked, but we could not see it until we implemented it and saw that it wasn't what we wanted. Here is our Slack plugin's output:

Screen Shot 2021-03-22 at 8 24 39 AM

I think it would be very helpful to see something similar in the docs for the official one.

Additionally, the Teams plugin is not listed in the sidebar of the docs, but I see it exists (I was just going through the Changelog to update our internal version of auto). It would be great to add the docs for it and a screenshot of the output as well, if possible (our company got acquired in october and we're in a weird state where we use both Slack and Teams. yeah...)

@hipstersmoothie
Copy link
Collaborator Author

@reintroducing Just added the teams plugin to the sidebar and readme

Getting a screenshot of the current slack rendering. I don't use the teams plugin so I won't be able to provide one for that plugin. Contributions welcome

@hipstersmoothie
Copy link
Collaborator Author

Will be using this as the preview for the slack notes

Screen Shot 2021-03-22 at 10 56 14 AM

@reintroducing
Copy link

awesome, appreciate it. we have not implemented the Teams integration for our auto config yet, but if/when we do, i'll grab a screenshot and send it over, just don't hold your breath :)

Appreciate you adding that though, i think it'll be very helpful for others to see.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Increment the minor version when merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants