Skip to content

Commit

Permalink
integration-docs: Update Github Actions for new doc format.
Browse files Browse the repository at this point in the history
Part of #29592.
  • Loading branch information
Niloth-p committed Dec 19, 2024
1 parent f2e1c1e commit d21f2d1
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions templates/zerver/integrations/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
It's easy to send Zulip messages from GitHub Actions! This is useful:
# Zulip GitHub Actions integration

* If you want to report the success or failure of an Action to Zulip.
* If you want to send output from your actions to Zulip.
It's easy to send Zulip messages from GitHub Actions!

Instructions are available [here](https://github.com/zulip/github-actions-zulip#readme).
{start_tabs}

See also the [GitHub integration](/integrations/doc/github).
1. {!create-a-generic-bot.md!}
Note down the bot's email address and API key.

1. To send Zulip notifications whenever your workflow runs, add the
`zulip/github-actions-zulip/send-message@v1` action to your GitHub
Actions workflow file, and set the input values as specified in the
[README][README] of the [Zulip GitHub Actions repository][repo].

{end_tabs}

### Related documentation

* [Zulip GitHub Actions repository][repo]

* [Configuring the Zulip Send Message Action][README]

* [GitHub integration](/integrations/doc/github)

[README]: https://github.com/zulip/github-actions-zulip/blob/main/send-message/README.md
[repo]: https://github.com/zulip/github-actions-zulip

0 comments on commit d21f2d1

Please sign in to comment.