Skip to content

Commit 3857c2a

Browse files
authored
Merge pull request #149 from argos-ci/slack-notifications
feat: slack notificaiton doc
2 parents c5c1a98 + a410ad2 commit 3857c2a

File tree

5 files changed

+76
-5
lines changed

5 files changed

+76
-5
lines changed

docs/learn/notifications.mdx renamed to docs/learn/pull-request-comments.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
slug: /notifications
3-
title: Notifications & Alerts
2+
slug: /pull-request-comments
3+
title: Pull request comments
44
---
55

66
import githubPrComment from "@site/src/img/github-pr-comment.png";
77

8-
# Notifications & Alerts
8+
# Pull request comments
99

1010
Stay informed with Argos: Get build results directly in your GitHub pull requests for a streamlined review process and efficient change management.
1111

12-
## Pull request comment overview
12+
## Overview
1313

1414
Every time there's an update to a build status, Argos automatically comment to the associated pull request thread. This comment contains the latest build status, together with a convenient link that leads you directly to the detailed build page on Argos.
1515

@@ -20,7 +20,7 @@ Every time there's an update to a build status, Argos automatically comment to t
2020
style={{ marginBottom: 20, width: 600 }}
2121
/>
2222

23-
## Silence pull request Comments
23+
## Silence pull request comments
2424

2525
If you would like to stop automatic comments from appearing on your pull request by the Argos GitHub bot, you can silence them through the project Settings:
2626

docs/learn/slack-notifications.mdx

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
slug: /slack-notifications
3+
title: Slack notifications
4+
---
5+
6+
import slackNotification from "./slack-notifications/slack-notification-example.png";
7+
import automationConditions from "./slack-notifications/automation-conditions.png";
8+
import slackChannelId from "./slack-notifications/slack-channel-id.png";
9+
10+
Argos can send Slack notifications when a build is completed or reviewed to keep your team informed of changes.
11+
12+
:::note
13+
Slack notifications are available on Pro and Enterprise plans
14+
:::
15+
16+
<img
17+
src={slackNotification}
18+
alt="Slack notification sent by Argos"
19+
className="rounded"
20+
style={{ marginBottom: 20, width: 600 }}
21+
/>
22+
_Example of a Slack notification sent by Argos_
23+
24+
## Set up Slack notifications
25+
26+
Set up a Slack notification rule using Argos automations.
27+
28+
1. Go to the **Automations** tab in your Argos project and click on **New Automation**.
29+
2. Name your automation, e.g., "Notify Slack on build completion".
30+
3. Under **WHEN**, select one or several events that will trigger the notification.
31+
4. (Optional) Under **IF**, add conditions such as "Build type is check".
32+
33+
<img
34+
src={automationConditions}
35+
alt="Automation conditions example"
36+
className="rounded"
37+
style={{ marginBottom: 30, marginTop: 0, paddingTop: 0, width: 600 }}
38+
/>
39+
40+
5. Under **THEN**, choose the action **Send notification to Slack**.
41+
42+
If this is your first time using Slack with Argos, click **Connect to Slack** and follow the connection flow.
43+
44+
6. Select the Slack channel and optionally provide the channel ID.
45+
46+
<img
47+
src={slackChannelId}
48+
alt="Locate Slack channel ID"
49+
className="rounded"
50+
style={{ marginBottom: 30, marginTop: 0, paddingTop: 0, width: 600 }}
51+
/>
52+
_Finding the ID of a Slack Channel_
53+
54+
7. Click **Send test notification** to verify the connection. A test message will be sent to the selected channel.
55+
8. Click **Create Rule** to activate it.
56+
57+
## Common use cases
58+
59+
- Notify #qa when a build is created and should be reviewed
60+
- Notify #frontend-team when a build changes are requested
61+
- Alert #product when auto-approved builds are created
62+
- Post only failed builds to #build-failures
63+
64+
## Troubleshooting and Tips
65+
66+
- Make sure the Argos app is authorized in your Slack workspace.
67+
- For private channels, manually invite the bot with `/invite @Argos`.
68+
- Only Argos team admins can configure Slack integrations.
69+
- You can test notifications anytime using **Send test notification**.
70+
71+
Need help setting up Slack integration? Reach out via [Discord](https://argos-ci.com/discord) or [contact support](mailto:[email protected]).
18 KB
Loading
193 KB
Loading
41.3 KB
Loading

0 commit comments

Comments
 (0)