-
Notifications
You must be signed in to change notification settings - Fork 10
Move send message action into a subdirectory #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,9 @@ | ||
| # Zulip Send Message Action | ||
| # Zulip GitHub Actions | ||
|
|
||
| [](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/). | ||
|
|
||
| ## 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) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?