paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 05:23:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

integrations: Update Capistrano Documentation.

Browse Source 
I have updated the capistrano docs so that the indentations are all
correct and align with the numbers correctly.

This one, if wanting to pout backticks round the code whilst indented,
doesn't render properly. Has to be double indented.

Fixes #17633.
This commit is contained in:
Adam Birds
2021-03-16 00:41:32 +00:00
committed by Tim Abbott
parent 25658153ca
commit 3acdbd277a
1 changed files with 19 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
templates/zerver/integrations/capistrano.md
View File

@@ -1,31 +1,29 @@
Get Zulip notifications for your Capistrano deploys!
1. {!create-a-bot-indented.md!}
1. {!create-a-bot-indented.md!}
1. {!download-python-bindings.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. Here's some example code for
sending a Zulip notification when a deployment has completed:
1. You can now send Zulip messages by calling the `zulip-send`
utility from your `deploy.rb` config file. Here's some example code for
sending a Zulip notification when a deployment has completed:
``` bash
after 'deploy', 'notify:humbug'
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@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
--site={{ api_url }} \
--stream commits --subject deployments || true"
end
end
```
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@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
--site={{ api_url }} \
--stream commits --subject deployments || true"
end
end
The `--user` and `--api-key` should be the email and API key of the Zulip
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.
The `--user` and `--api-key` should be the email and API key of the Zulip
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 ""