Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/local-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
run: |
echo "::set-output name=value::${{ env.ZULIP_API_KEY != '' }}"
- name: Send a stream message
uses: ./
uses: ./send-message
with:
email: 'it-bot@github-actions-test.zulipchat.com'
api-key: ${{ secrets.ZULIP_API_KEY }}
Expand All @@ -34,7 +34,7 @@ jobs:
content: 'I come not, friends, to steal away your hearts.'
if: ${{ steps.enable_integration_tests.outputs.value == 'true' }}
- name: Send a private message
uses: ./
uses: ./send-message
with:
email: 'it-bot@github-actions-test.zulipchat.com'
api-key: ${{ secrets.ZULIP_API_KEY }}
Expand All @@ -53,7 +53,7 @@ jobs:
- name: Package
run: npm run package
- name: Missing API key and password
uses: ./
uses: ./send-message
with:
email: 'it-bot@github-actions-test.zulipchat.com'
organization-url: 'https://github-actions-test.zulipchat.com'
Expand All @@ -63,7 +63,7 @@ jobs:
content: 'I come not, friends, to steal away your hearts.'
continue-on-error: true
- name: Wrong organization URL
uses: ./
uses: ./send-message
with:
email: 'it-bot@github-actions-test.zulipchat.com'
api-key: ${{ secrets.ZULIP_API_KEY }}
Expand Down
38 changes: 0 additions & 38 deletions .github/workflows/release.yml

This file was deleted.

67 changes: 4 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,9 @@
# Zulip Send Message Action
# Zulip GitHub Actions

[![GitHub Action badge](https://github.com/zulip/github-actions-zulip/workflows/test-local/badge.svg)](https://github.com/zulip/github-actions-zulip/actions?query=workflow%3Atest-local)

This action sends a message to [Zulip](https://zulip.com/).
This is a collection of GitHub Actions to interact with [Zulip](https://zulip.com/).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main README now states that this repository contains a collection of GitHub Actions.
In the "Actions" section, for each action, we have a link to the README.

Does that work for you?


## Inputs
## Actions

### `api-key`

**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.

### `email`

**Required** Email address of the user who owns the API key mentioned above.

### `organization-url`

**Required** Zulip organization canonical URL.

### `to`

**Required** For stream messages, either the name or integer ID of the stream.
For private messages, either a list containing integer user IDs or a list containing string email addresses.

### `type`

**Required** The type of message to be sent. `private` for a private message and `stream` for a stream message.
Must be one of: `private`, `stream`.

### `topic`

**Optional** The topic of the message. Only required for stream messages (`type="stream"`), ignored otherwise.
Maximum length of 60 characters.

### `content`

**Required** The content of the message. Maximum message size of 10000 bytes.
Format your message using [Zulip Markdown](https://zulip.com/help/format-your-message-using-markdown).

## Example usage

**Send a stream message**
```yml
- name: Send a stream message
uses: zulip/github-actions-zulip@v0.2.0
with:
api-key: 'abcd1234'
email: 'username@example.com'
organization-url: 'https://org.zulipchat.com'
to: 'social'
type: 'stream'
topic: 'Castle'
content: 'I come not, friends, to steal away your hearts.'
```

**Send a private message**
```yml
- name: Send a private message
uses: zulip/github-actions-zulip@v0.2.0
with:
api-key: 'abcd1234'
email: 'username@example.com'
organization-url: 'https://org.zulipchat.com'
to: '9' # user_id
type: 'private'
content: 'With mirth and laughter let old wrinkles come.'
```
- [Sends a message to Zulip](./send-message/README.md)
Loading