Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit3886e2f

Browse files
authored
Email notification integration (#795)
* Add article for email notificationAdded article for email notifications for pipeline builds* Add article for email notificationsAdded article for email notification, updated slack and user settings articles for clarity* Add images for failed build notificationAdded image for failed build notification via email
1 parent02be798 commit3886e2f

File tree

6 files changed

+76
-13
lines changed

6 files changed

+76
-13
lines changed

‎_data/nav.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,8 @@
271271
-title:Notifications
272272
url:"/notifications"
273273
sub-pages:
274+
-title:Email
275+
url:"/email-integration"
274276
-title:Slack
275277
url:"/slack-integration"
276278
-title:Jira

‎_docs/administration/user-self-management/user-settings.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,19 @@ As a Codefresh user, you can manage several settings and resources through your
2525

2626
Configure the email notifications you want to receive for builds based on the build status: only successful, only failed, or for both successful and failed builds.
2727

28-
>By default, email notifications for builds are disabled for_all users_.
29-
When you enable notifications, remember that you will receive notifications only for the builds that you have permissions to access. If you don’t have access to a pipeline, you will not have access also to its builds.
28+
>**NOTES**:
29+
By default, email notifications for builds are disabled for _all users_.<br><br>
30+
When you enable notifications, remember that you will receive notifications only for those builds:<br>
31+
>- That you have permissions to access. If you don’t have access to a pipeline, you will not have access also to its builds.
32+
>- Launched automatically by Git/Cron triggers. To enable email notifications also for builds launched manually, select the**Report notification on pipeline execution** option in the Git/Cron Settings for the specific pipeline. See[Git](({{site.baseurl}}/docs/pipelines/triggers/git-triggers/) and[Cron]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/) triggers.
3033
34+
<br><br>
3135

3236
* In**Notifications**, define the email address and select the notifications:
3337
* Email address for the notifications. By default, it's the same address you used to[sign up]({{site.baseurl}}/docs/administration/account-user-management/create-codefresh-account/).
3438
* Select the build statuses for which to receive notifications.
3539

3640

37-
3841
{% include image.html
3942
lightbox="true"
4043
file="/images/administration/user-settings/notifications.png"
@@ -110,7 +113,8 @@ max-width="80%"
110113

111114

112115
##Related articles
113-
[Managing Git PATs]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/)
116+
[Managing Git PATs]({{site.baseurl}}/docs/administration/user-self-management/manage-pats/)
117+
114118

115119

116120

‎_docs/integrations/notifications.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc: true
99
Codefresh enables you to send notifications about events.
1010

1111
Codefresh supports the following notification channels:
12-
- Email
13-
-[Slack]({{site.baseurl}}/docs/integrations/notifications/slack-integration/)
14-
-[Jira]({{site.baseurl}}/docs/integrations/notifications/jira-integration/)
12+
-[Email]({{site.baseurl}}/docs/integrations/notifications/email-integration/)
13+
-[Slack]({{site.baseurl}}/docs/integrations/notifications/slack-integration/)
14+
-[Jira]({{site.baseurl}}/docs/integrations/notifications/jira-integration/)
1515

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title:"Email notifications"
3+
description:"Get email notifications for pipeline builds"
4+
group:integrations
5+
sub_group:notifications
6+
toc:true
7+
---
8+
9+
You can enable email notifications for pipeline builds based on the build's status. Email notifications do not require any integration. Each user needs to enable the notifications as part of the user settings.
10+
11+
##Email notification options
12+
13+
As part of user settings, individual users can enable notifications for pipeline builds based on their status:
14+
* Successful
15+
* Failed
16+
17+
See[Enable email notifications for pipeline builds]({{site.baseurl}}/docs/administration/user-self-management/user-settings/#enable-email-notifications-for-pipeline-builds).
18+
19+
<!---Here's an example of an email notification for a failed build:
20+
21+
{% include image.html
22+
lightbox="true"
23+
file="/images/integrations/email/failed-build-notification.png"
24+
url="/images/integrations/email/failed-build-notification.png"
25+
caption="Example of email notification for failed build"
26+
alt="Example of email notification for failed build"
27+
max-width="60%"
28+
%}
29+
-->
30+
31+
##How email notifications work
32+
33+
When you have email notifications enabled for pipeline builds, the default behavior is similar to that of Slack notifications:
34+
35+
1. All pipelines launched automatically by[Git/Cron triggers]({{site.baseurl}}/docs/pipelines/triggers/) send email notifications.
36+
1. All pipelines executed manually, do**NOT** send email notifications.
37+
You can override the default behavior for notifications through the**Report notification on pipeline execution** option for pipelines. This is available under**Advanced Settings** for Git and Cron triggers, or the Run settings of a pipeline.
38+
When selected, sends email notifications for pipelines which are executed manually.
39+
40+
{% include image.html
41+
lightbox="true"
42+
file="/images/integrations/slack/report-notifications.png"
43+
url="/images/integrations/slack/report-notifications.png"
44+
alt="Select to send notifications for manually executed builds"
45+
caption="Select to send notifications for manually executed builds"
46+
max-width="40%"
47+
%}
48+
49+
50+
51+
##Related articles
52+
[Git triggers in pipelines]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/)
53+
[Cron triggers in pipelines]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/)
54+
[Slack integration for pipelines]({{site.baseurl}}/_docs/integrations/notifications/slack-integration/)
55+
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
56+
[Monitoring pipelines]({{site.baseurl}}/docs/pipelines/monitoring-pipelines/)

‎_docs/integrations/notifications/slack-integration.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Enable notifications for builds based on their status:
3535
%}
3636

3737

38-
For detailed information, see[Policy settings for pipelines]({{site.baseurl}}/docs/pipelines/pipelines/#policies).
38+
<!---For detailed information, see [Policy settings for pipelines]({{site.baseurl}}/docs/pipelines/pipelines/#policies).-->
3939

4040

4141

@@ -69,16 +69,15 @@ When you have Slack integration enabled:
6969

7070
1. All pipelines launched automatically by[triggers]({{site.baseurl}}/docs/pipelines/triggers/), send Slack notifications
7171
1. All pipelines executed manually, do**NOT** send Slack notifications.
72-
73-
You can override this behavior by toggling the checkbox**Report notification on pipeline execution** under**Advanced Settings**
74-
either in a Git trigger dialog or the Run settings of a pipeline.
72+
You can override the default behavior for notifications through the**Report notification on pipeline execution** option for pipelines. This is available under**Advanced Settings** for Git and Cron triggers, or the Run settings of a pipeline.
73+
When selected, sends email notifications for pipelines which are executed manually.
7574

7675
{% include image.html
7776
lightbox="true"
7877
file="/images/integrations/slack/report-notifications.png"
7978
url="/images/integrations/slack/report-notifications.png"
80-
alt="Manual Slack override"
81-
caption="Manual Slack override"
79+
alt="Select to send notifications for manually executed builds"
80+
caption="Select to send notifications for manually executed builds"
8281
max-width="40%"
8382
%}
8483

@@ -93,5 +92,7 @@ If you wish for more fine-grained control over Slack notifications, then take a
9392

9493
##Related articles
9594
[Git triggers in pipelines]({{site.baseurl}}/docs/pipelines/triggers/git-triggers/)
95+
[Cron triggers in pipelines]({{site.baseurl}}/docs/pipelines/triggers/cron-triggers/)
96+
[Email notifications for pipelines]({{site.baseurl}}/docs/integrations/notifications/email-integration/)
9697
[Creating pipelines]({{site.baseurl}}/docs/pipelines/pipelines/)
9798
[Monitoring pipelines]({{site.baseurl}}/docs/pipelines/monitoring-pipelines/)
39.8 KB
Loading

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp