Skip to content

Commit f8e411e

Browse files
ggrossetietimabbott
authored andcommitted
Highlight that api-key is a secret
resolves #46
1 parent 44cbce7 commit f8e411e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

send-message/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This action sends a message to [Zulip](https://zulip.com/).
77
### `api-key`
88

99
**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.
10+
You should store the API key [as a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
1011

1112
### `email`
1213

@@ -43,7 +44,7 @@ Format your message using [Zulip Markdown](https://zulip.com/help/format-your-me
4344
- name: Send a stream message
4445
uses: zulip/github-actions-zulip/send-message@v1
4546
with:
46-
api-key: 'abcd1234'
47+
api-key: ${{ secrets.ZULIP_API_KEY }}
4748
4849
organization-url: 'https://org.zulipchat.com'
4950
to: 'social'
@@ -57,7 +58,7 @@ Format your message using [Zulip Markdown](https://zulip.com/help/format-your-me
5758
- name: Send a private message
5859
uses: zulip/github-actions-zulip/send-message@v1
5960
with:
60-
api-key: 'abcd1234'
61+
api-key: ${{ secrets.ZULIP_API_KEY }}
6162
6263
organization-url: 'https://org.zulipchat.com'
6364
to: '9' # user_id

0 commit comments

Comments
 (0)