64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# Zulip Capistrano Integration
|
|
|
|
Get Zulip notifications for your Capistrano deploys!
|
|
|
|
{start_tabs}
|
|
|
|
1. {!create-an-incoming-webhook.md!}
|
|
|
|
1. {!download-python-bindings.md!}
|
|
|
|
1. You can now send Zulip messages by calling the `zulip-send`
|
|
utility from your `deploy.rb` config file.
|
|
|
|
1. Here's some example code for sending a Zulip notification when a
|
|
deployment has completed:
|
|
|
|
after 'deploy', 'notify:humbug'
|
|
|
|
namespace :notify do
|
|
desc "Post a message to Zulip after deploy"
|
|
task :humbug do
|
|
run_locally "echo 'I just deployed to #{stage}! :tada:' | zulip-send \
|
|
--user capistrano-bot@{{ display_host }} --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
|
|
--site={{ zulip_url }} \
|
|
--stream commits --subject deployments || true"
|
|
end
|
|
end
|
|
|
|
Use your bot's email address and [API key][3] for `--user` and
|
|
`--api-key` respectively.
|
|
|
|
{end_tabs}
|
|
|
|
{!congrats.md!}
|
|
|
|
|
|
|
|
### Configuration Options
|
|
|
|
* Customize the notification trigger by replacing `deploy` in the above
|
|
example with [any stage][1] of your deployment process.
|
|
|
|
### Related documentation
|
|
|
|
* [Capistrano's Before/After Hooks][1]
|
|
* [Configuring the Python bindings][2]
|
|
|
|
[1]: https://capistranorb.com/documentation/getting-started/before-after/
|
|
[2]: https://zulip.com/api/configuring-python-bindings
|
|
[3]: https://zulip.com/api/api-keys#get-a-bots-api-key
|