mirror of https://github.com/zulip/zulip.git
integration-docs: Update Capistrano for new doc format.
Part of zulip#29592.
This commit is contained in:
parent
a9a72c2b5d
commit
43c8eb9796
|
@ -1,5 +1,9 @@
|
||||||
|
# Zulip Capistrano Integration
|
||||||
|
|
||||||
Get Zulip notifications for your Capistrano deploys!
|
Get Zulip notifications for your Capistrano deploys!
|
||||||
|
|
||||||
|
{start_tabs}
|
||||||
|
|
||||||
1. {!create-an-incoming-webhook.md!}
|
1. {!create-an-incoming-webhook.md!}
|
||||||
|
|
||||||
1. {!download-python-bindings.md!}
|
1. {!download-python-bindings.md!}
|
||||||
|
@ -14,26 +18,24 @@ Get Zulip notifications for your Capistrano deploys!
|
||||||
desc "Post a message to Zulip after deploy"
|
desc "Post a message to Zulip after deploy"
|
||||||
task :humbug do
|
task :humbug do
|
||||||
run_locally "echo 'I just deployed to #{stage}! :tada:' | zulip-send \
|
run_locally "echo 'I just deployed to #{stage}! :tada:' | zulip-send \
|
||||||
--user capistrano-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
|
--user <email of bot> --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
|
||||||
--site={{ api_url }} \
|
--site={{ api_url }} \
|
||||||
--stream commits --subject deployments || true"
|
--stream commits --subject deployments || true"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
The `--user` and `--api-key` should be the email and API key of the Zulip
|
{end_tabs}
|
||||||
bot created above. You can also put these values in a `~/.zuliprc` file on
|
|
||||||
your Capistrano machine. See our [API docs](/api/) for instructions on
|
|
||||||
creating that file.
|
|
||||||
|
|
||||||
!!! tip ""
|
|
||||||
|
|
||||||
You can change the `deploy` above to another step of
|
|
||||||
your deployment process, if you'd like the notification to fire
|
|
||||||
at a different time. See [Capistrano's Before/After Hooks page][1]
|
|
||||||
for more information!
|
|
||||||
|
|
||||||
[1]: https://capistranorb.com/documentation/getting-started/before-after/
|
|
||||||
|
|
||||||
{!congrats.md!}
|
{!congrats.md!}
|
||||||
|
|
||||||
![Capistrano bot message](/static/images/integrations/capistrano/001.png)
|
![Capistrano bot message](/static/images/integrations/capistrano/001.png)
|
||||||
|
|
||||||
|
### Configuration Options
|
||||||
|
|
||||||
|
Customize the notification trigger by replacing `deploy` with any stage of your deployment process.
|
||||||
|
|
||||||
|
### Related documentation
|
||||||
|
|
||||||
|
[Capistrano's Before/After Hooks page][1]
|
||||||
|
|
||||||
|
[1]: https://capistranorb.com/documentation/getting-started/before-after/
|
||||||
|
|
Loading…
Reference in New Issue