Skip to content
This repository was archived by the owner on Nov 10, 2019. It is now read-only.

Commit a43f7a2

Browse files
Merge pull request #39 from codefresh-io/sendgrid
add sendgrid plugin manifest
2 parents 846cbae + a78dcc2 commit a43f7a2

File tree

3 files changed

+66
-1
lines changed

3 files changed

+66
-1
lines changed

dynamic-catalog.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# **Catalog**
2-
Created at ** Thu Dec 20 2018 10:33:16 GMT+0000 (Coordinated Universal Time)**
2+
Created at ** Mon Dec 24 2018 11:31:14 GMT+0000 (Coordinated Universal Time)**
33

44

55
| Plugin Name | Image | Description | source | Tags |
@@ -19,6 +19,7 @@ Created at ** Thu Dec 20 2018 10:33:16 GMT+0000 (Coordinated Universal Time)**
1919
| kompose | codefresh/plugin-helm | Release a Docker Compose to Kubernetes | https://github.com/codefresh-io/cf-kompose-plugin | **`docker-compose`** **`docker`** **`kompose`** **`kubernetes`** |
2020
| release-to-NPM | | | | |
2121
| run-jenkins-job | codefresh/run-jenkins-jobs | Run jenkins job from codefresh pipeline | https://github.com/codefresh-io/cf-run-jenkins-jobs | **`docker`** **`jenkins`** |
22+
| sendgrid | codefresh/sendgridplugin | Send e-mail via Sendgrid | https://github.com/codefresh-io/sendgridplugin | **`mail`** **`sendgrid`** |
2223
| slack | codefresh/slack-message-sender | Send message to slack channel | https://github.com/codefresh-io/slack-message-sender | **`slack`** |
2324
| slack-notifier | codefresh/slacknotifier | Send message to slack channel | https://github.com/codefresh-io/slack-notifier | **`slack`** |
2425
| testplugin | codefresh/github-pr-plugin | Creates GitHub pull request | https://github.com/codefresh-io/github-pr-plugin | **`testplugin`** |

plugins/sendgrid/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Codefresh plugin for send e-mail letters
2+
3+
Codefresh plugin for send e-mail notification via SendGrid
4+
5+
## Main env variables
6+
- `SENDGRID_APIKEY` - API key from SendGrid
7+
- `SENDGRID_MAIL` - mail where the letter will be sent, you can use _comma_ divider to send on multiple mails (ex. `mail1@example.com, mail2@exmaple.com`)
8+
- `SENDGRID_FROM` - from header of mail
9+
- `SENDGRID_SUBJECT` - subject header of mail
10+
- `SENDGRID_TYPE` - type of mail [build, message, custom]
11+
12+
## Mail types
13+
### build
14+
Info about current build
15+
### message
16+
Send simple message with text from `SENDGRID_MESSAGE`
17+
### custom
18+
Send message with custom template via [ejs](https://www.npmjs.com/package/ejs) provided `SENDGRID_TEMPLATE`
19+
20+
## Config for codefresh.yml
21+
```
22+
version: '1.0'
23+
...
24+
steps:
25+
...
26+
TestMail:
27+
title: Test Mail
28+
image: 'codefresh/sendgridplugin:latest'
29+
...
30+
...
31+
```

plugins/sendgrid/plugin.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
image: codefresh/sendgridplugin
2+
version: latest
3+
description: Send e-mail via Sendgrid
4+
keywords:
5+
- mail
6+
- sendgrid
7+
home: https://github.com/codefresh-io/sendgridplugin
8+
sources:
9+
- https://github.com/codefresh-io/sendgridplugin
10+
maintainers:
11+
- name: Pavel Kostohrys
12+
email: pavel@codefresh.io
13+
icon: https://images.ctfassets.net/bx16dovk9m7p/XNo9W4lwAMsai8KOikAae/35f6df5bf800dd4993c2d98376448f0d/a37a5b5ab495b5531dd406d40baa8a5c.png
14+
envs:
15+
- name: SENDGRID_APIKEY
16+
type: required
17+
description: API key from SendGrid
18+
- name: SENDGRID_MAIL
19+
type: required
20+
description: mail where the letter will be sent, you can use comma divider to send on multiple mails (ex.: mail1@example.com, mail2@exmaple.com)
21+
- name: SENDGRID_FROM
22+
type: required
23+
description: from header of mail
24+
- name: SENDGRID_SUBJECT
25+
type: required
26+
description: subject header of mail
27+
- name: SENDGRID_TYPE
28+
type: required
29+
description: type of mail [build, message, custom]
30+
- name: SENDGRID_MESSAGE
31+
description: Text of message for type message
32+
- name: SENDGRID_TEMPLATE
33+
description: Template of message for type message

0 commit comments

Comments
 (0)