|
1 | | -# Zulip Send Message Action |
| 1 | +# Zulip GitHub Actions |
2 | 2 |
|
3 | 3 | [](https://github.com/zulip/github-actions-zulip/actions?query=workflow%3Atest-local) |
4 | 4 |
|
5 | | -This action sends a message to [Zulip](https://zulip.com/). |
| 5 | +This is a collection of GitHub Actions to interact with [Zulip](https://zulip.com/). |
6 | 6 |
|
7 | | -## Inputs |
| 7 | +## Actions |
8 | 8 |
|
9 | | -### `api-key` |
10 | | - |
11 | | -**Required** [API key](https://zulip.com/api/api-keys) used to interact with the Zulip API. You can get an API key through Zulip's web interface. |
12 | | - |
13 | | -### `email` |
14 | | - |
15 | | -**Required** Email address of the user who owns the API key mentioned above. |
16 | | - |
17 | | -### `organization-url` |
18 | | - |
19 | | -**Required** Zulip organization canonical URL. |
20 | | - |
21 | | -### `to` |
22 | | - |
23 | | -**Required** For stream messages, either the name or integer ID of the stream. |
24 | | -For private messages, either a list containing integer user IDs or a list containing string email addresses. |
25 | | - |
26 | | -### `type` |
27 | | - |
28 | | -**Required** The type of message to be sent. `private` for a private message and `stream` for a stream message. |
29 | | -Must be one of: `private`, `stream`. |
30 | | - |
31 | | -### `topic` |
32 | | - |
33 | | -**Optional** The topic of the message. Only required for stream messages (`type="stream"`), ignored otherwise. |
34 | | -Maximum length of 60 characters. |
35 | | - |
36 | | -### `content` |
37 | | - |
38 | | -**Required** The content of the message. Maximum message size of 10000 bytes. |
39 | | -Format your message using [Zulip Markdown](https://zulip.com/help/format-your-message-using-markdown). |
40 | | - |
41 | | -## Example usage |
42 | | - |
43 | | -**Send a stream message** |
44 | | -```yml |
45 | | -- name: Send a stream message |
46 | | - uses: zulip/github-actions-zulip@v0.2.0 |
47 | | - with: |
48 | | - api-key: 'abcd1234' |
49 | | - email: 'username@example.com' |
50 | | - organization-url: 'https://org.zulipchat.com' |
51 | | - to: 'social' |
52 | | - type: 'stream' |
53 | | - topic: 'Castle' |
54 | | - content: 'I come not, friends, to steal away your hearts.' |
55 | | -``` |
56 | | -
|
57 | | -**Send a private message** |
58 | | -```yml |
59 | | -- name: Send a private message |
60 | | - uses: zulip/github-actions-zulip@v0.2.0 |
61 | | - with: |
62 | | - api-key: 'abcd1234' |
63 | | - email: 'username@example.com' |
64 | | - organization-url: 'https://org.zulipchat.com' |
65 | | - to: '9' # user_id |
66 | | - type: 'private' |
67 | | - content: 'With mirth and laughter let old wrinkles come.' |
68 | | -``` |
| 9 | +- [Sends a message to Zulip](./send-message/README.md) |
0 commit comments